/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\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
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, distribute, and sell this \r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in \r
+ all 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
const struct\r
{\r
uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this\r
- * structure controls.\r
+ * structure controls\r
*/\r
\r
- uint8_t DataINEndpointNumber; /**< Endpoint number of the incomming Audio Streaming data, if available\r
- * (zero if unused).\r
+ uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming Audio Streaming data, if available\r
+ * (zero if unused)\r
*/\r
- uint16_t DataINEndpointSize; /**< Size in bytes of the incomming Audio Streaming data endpoint, if available\r
- * (zero if unused).\r
+ uint16_t DataINEndpointSize; /**< Size in bytes of the incoming Audio Streaming data endpoint, if available\r
+ * (zero if unused)\r
*/\r
\r
uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing Audio Streaming data, if available\r
- * (zero if unused).\r
+ * (zero if unused)\r
*/\r
uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing Audio Streaming data endpoint, if available\r
- * (zero if unused).\r
+ * (zero if unused)\r
*/ \r
} Config; /**< Config data for the USB class interface within the device. All elements in this section\r
* <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
* given Audio interface is selected.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
*\r
- * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+ * \return Boolean true if the endpoints were successfully configured, false otherwise\r
*/\r
bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
- /** Processes incomming control requests from the host, that are directed to the given Audio class interface. This should be\r
+ /** Processes incoming control requests from the host, that are directed to the given Audio class interface. This should be\r
* linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
*/\r
void Audio_Device_ProcessControlRequest(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** General management task for a given Audio class interface, required for the correct operation of the interface. This should\r
- * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
- *\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
- */\r
- void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Determines if the given audio interface is ready for a sample to be read from it, and selects the streaming\r
* OUT endpoint ready for reading.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
*\r
* \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
*/\r
/** Determines if the given audio interface is ready to accept the next sample to be written to it, and selects\r
* the streaming IN endpoint ready for writing.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
*\r
* \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
*/\r
bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
\r
/* Inline Functions: */\r
+ /** General management task for a given Audio class interface, required for the correct operation of the interface. This should\r
+ * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+ *\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
+ */\r
+ static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
+ static inline void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
+ {\r
+ (void)AudioInterfaceInfo;\r
+ }\r
+\r
/** Reads the next 8-bit audio sample from the current audio interface.\r
*\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+ * \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
*\r
* \return Signed 8-bit audio sample from the audio interface\r
*/\r
static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
{\r
int8_t Sample;\r
+ \r
+ (void)AudioInterfaceInfo;\r
\r
Sample = Endpoint_Read_Byte();\r
\r
\r
/** Reads the next 16-bit audio sample from the current audio interface.\r
*\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+ * \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
*\r
* \return Signed 16-bit audio sample from the audio interface\r
*/\r
{\r
int16_t Sample;\r
\r
+ (void)AudioInterfaceInfo;\r
+\r
Sample = (int16_t)Endpoint_Read_Word_LE();\r
\r
if (!(Endpoint_BytesInEndpoint()))\r
\r
/** Reads the next 24-bit audio sample from the current audio interface.\r
*\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
+ * \note This should be preceded immediately by a call to the USB_Audio_IsSampleReceived() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
* \return Signed 24-bit audio sample from the audio interface\r
*/\r
static inline int32_t Audio_Device_ReadSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo) ATTR_ALWAYS_INLINE;\r
{\r
int32_t Sample;\r
\r
+ (void)AudioInterfaceInfo;\r
+\r
Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());\r
\r
if (!(Endpoint_BytesInEndpoint()))\r
\r
/** Writes the next 8-bit audio sample to the current audio interface.\r
*\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+ * \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
* \param[in] Sample Signed 8-bit audio sample\r
*/\r
static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
\r
/** Writes the next 16-bit audio sample to the current audio interface.\r
*\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+ * \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
* \param[in] Sample Signed 16-bit audio sample\r
*/\r
static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
\r
/** Writes the next 24-bit audio sample to the current audio interface.\r
*\r
- * \note This should be preceeded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
+ * \note This should be preceded immediately by a call to the USB_Audio_IsReadyForNextSample() function to ensure that\r
* the correct endpoint is selected and ready for data.\r
*\r
- * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state.\r
+ * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state\r
* \param[in] Sample Signed 24-bit audio sample\r
*/\r
static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
projects / pub / USBasp.git / blobdiff