Added const modifiers to device mode class drivers.

[pub/lufa.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 faa9c92..7ce0624 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/Audio.h
+++ b/LUFA/Drivers/USB/Class/Device/Audio.h
@@ -97,25 +97,25 @@
                         *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
                         *  given Audio interface is selected.\r
                         *\r
-                        *  \param 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
                         */\r
-                       bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+                       bool Audio_Device_ConfigureEndpoints(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
 \r
                        /** Processes incomming 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_UnhandledControlPacket() event.\r
                         *\r
-                        *  \param 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_ProcessControlPacket(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+                       void Audio_Device_ProcessControlPacket(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\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 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* AudioInterfaceInfo);\r
+                       void Audio_Device_USBTask(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
                        \r
                        /** Reads the next 8-bit audio sample from the current audio interface.\r
                         *\r
@@ -149,43 +149,43 @@
                         *  \note This should be preceeded 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 Sample  Signed 8-bit audio sample\r
+                        *  \param[in] Sample  Signed 8-bit audio sample\r
                         */\r
-                       void Audio_Device_WriteSample8(int8_t Sample);\r
+                       void Audio_Device_WriteSample8(const int8_t Sample);\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
                         *        the correct endpoint is selected and ready for data.\r
                         *\r
-                        *  \param Sample  Signed 16-bit audio sample\r
+                        *  \param[in] Sample  Signed 16-bit audio sample\r
                         */\r
-                       void Audio_Device_WriteSample16(int16_t Sample);\r
+                       void Audio_Device_WriteSample16(const int16_t Sample);\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
                         *        the correct endpoint is selected and ready for data.\r
                         *\r
-                        *  \param Sample  Signed 24-bit audio sample\r
+                        *  \param[in] Sample  Signed 24-bit audio sample\r
                         */\r
-                       void Audio_Device_WriteSample24(int32_t Sample);\r
+                       void Audio_Device_WriteSample24(const int32_t Sample);\r
 \r
                        /** Determines if the given audio interface is ready for a sample to be read from it.\r
                         *\r
-                        *  \param 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
-                       bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+                       bool Audio_Device_IsSampleReceived(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
 \r
                        /** Determines if the given audio interface is ready to accept the next sample to be written to it.\r
                         *\r
-                        *  \param 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
-                       bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* AudioInterfaceInfo);\r
+                       bool Audio_Device_IsReadyForNextSample(USB_ClassInfo_Audio_Device_t* const AudioInterfaceInfo);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r