projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Fix a bug in the Still Image Host Class driver where the returned block status code...
[pub/USBasp.git] / 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 67699fd..cf79e15 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -66,21 +66,21 @@
                                const struct\r
                                {\r
                                        uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device 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
                                                                                                                */\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
                                                                                                        */\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
                                                                                                  */\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
                                                                                                         */\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
                                                                                                   */                   \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
@@ -100,30 +100,30 @@
                         *  \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
                         *  \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
                         *\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
                         */\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
                         *  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
                         */\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
+                        *  \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
                         */\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
+                        *  \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
                         *\r
                         *  \return Boolean true if the given Audio interface has a sample to be read, false otherwise\r
                         */\r
@@ -132,7 +132,7 @@
                        /** 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
                        /** 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
+                        *  \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
                         *\r
                         *  \return Boolean true if the given Audio interface is ready to accept the next sample, false otherwise\r
                         */\r
@@ -141,10 +141,10 @@
                /* Inline Functions: */\r
                        /** Reads the next 8-bit audio sample from the current audio interface.\r
                         *\r
                /* Inline Functions: */\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
                         *        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
                         *\r
                         *  \return  Signed 8-bit audio sample from the audio interface\r
                         */\r
@@ -152,6 +152,8 @@
                        static inline int8_t Audio_Device_ReadSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo)\r
                        {\r
                                int8_t Sample;\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
                                Sample = Endpoint_Read_Byte();\r
 \r
@@ -163,10 +165,10 @@
 \r
                        /** Reads the next 16-bit audio sample from the current audio interface.\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
                         *        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
                         *  \return  Signed 16-bit audio sample from the audio interface\r
                         */\r
@@ -175,6 +177,8 @@
                        {\r
                                int16_t Sample;\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
                                Sample = (int16_t)Endpoint_Read_Word_LE();\r
                                          \r
                                if (!(Endpoint_BytesInEndpoint()))\r
@@ -185,10 +189,10 @@
 \r
                        /** Reads the next 24-bit audio sample from the current audio interface.\r
                         *\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
                         *        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
                         *  \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
@@ -196,6 +200,8 @@
                        {\r
                                int32_t Sample;\r
 \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
                                Sample = (((uint32_t)Endpoint_Read_Byte() << 16) | Endpoint_Read_Word_LE());\r
                                          \r
                                if (!(Endpoint_BytesInEndpoint()))\r
@@ -206,10 +212,10 @@
 \r
                        /** Writes the next 8-bit audio sample to the current audio interface.\r
                         *\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
                         *        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
                         *  \param[in] Sample  Signed 8-bit audio sample\r
                         */\r
                        static inline void Audio_Device_WriteSample8(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
@@ -225,10 +231,10 @@
 \r
                        /** Writes the next 16-bit audio sample to the current audio interface.\r
                         *\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
                         *        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
                         *  \param[in] Sample  Signed 16-bit audio sample\r
                         */\r
                        static inline void Audio_Device_WriteSample16(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
@@ -244,10 +250,10 @@
 \r
                        /** Writes the next 24-bit audio sample to the current audio interface.\r
                         *\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
                         *        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
                         *  \param[in] Sample  Signed 24-bit audio sample\r
                         */\r
                        static inline void Audio_Device_WriteSample24(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo,\r
USB isp AVR programmer