Added const modifiers to device mode class drivers.

[pub/lufa.git] / LUFA / Drivers / USB / Class / Device / MIDI.h

diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h
index e81089c..19ff5d4 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -54,12 +54,6 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Type Define: */\r
-                       /** Configuration information structure for \ref USB_ClassInfo_MIDI_Device_t MIDI device interface structures. */\r
-                       typedef  USB_ClassInfo_MIDI_Device_Config_t;\r
-       \r
-                       /** Current State information structure for \ref USB_ClassInfo_MIDI_Device_t MIDI device interface structures. */\r
-                       typedef  USB_ClassInfo_MIDI_Device_State_t;\r
-       \r
                        /** Class state structure. An instance of this structure should be made for each MIDI interface\r
                         *  within the user application, and passed to each of the MIDI class driver functions as the\r
                         *  MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.\r
@@ -92,41 +86,41 @@
                         *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
                         *  containing the given MIDI interface is selected.\r
                         *\r
-                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r
-                       bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);\r
+                       bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo);\r
                        \r
                        /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be\r
                         *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
                         *\r
-                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
                         */             \r
-                       void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);\r
+                       void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo);\r
 \r
                        /** General management task for a given MIDI 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 MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
                         */\r
-                       void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);\r
+                       void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo);\r
 \r
                        /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
                         *\r
-                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                        *  \param Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
+                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        *  \param[in] Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
                         */\r
-                       void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo, MIDI_EventPacket_t* Event);\r
+                       void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event);\r
 \r
                        /** Receives a MIDI event packet from the host.\r
                         *\r
-                        *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                        *  \param Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
+                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
+                        *  \param[out] Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
                         *\r
                         *  \return Boolean true if a MIDI event packet was received, false otherwise\r
                         */\r
-                       bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo, MIDI_EventPacket_t* Event);\r
+                       bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r