Move new Class Driver powered demos to a new ClassDriver subdirectory, re-add old...

[pub/USBasp.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 1782393..08a530a 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -28,6 +28,21 @@
   this software.\r
 */\r
 \r
+/** \ingroup Group_USBDeviceClassDrivers\r
+ *  @defgroup Group_USBClassMIDIDevice MIDI Device Class Driver - LUFA/Drivers/Class/Device/MIDI.h\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/Class/Device/MIDI.c\r
+ *\r
+ *  \section Module Description\r
+ *  Functions, macros, variables, enums and types related to the management of USB MIDI Class interfaces\r
+ *  within a USB device. Note that the MIDI class is actually a special case of the regular Audio class,\r
+ *  thus this module depends on structure definitions from the \ref Group_USBClassAudioDevice class driver module.\r
+ *\r
+ *  @{\r
+ */\r
+\r
 #ifndef _MIDI_CLASS_H_\r
 #define _MIDI_CLASS_H_\r
 \r
@@ -37,6 +52,11 @@
 \r
                #include <string.h>\r
 \r
+       /* Enable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       extern "C" {\r
+               #endif\r
+\r
        /* Macros: */\r
                /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */\r
                #define DSUBTYPE_InputJack          0x02\r
@@ -45,10 +65,10 @@
                #define DSUBTYPE_OutputJack         0x03\r
                \r
                /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */\r
-               #define JACKTYPE_EMBEDDED           0x01\r
+               #define MIDI_JACKTYPE_EMBEDDED      0x01\r
 \r
                /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */\r
-               #define JACKTYPE_EXTERNAL           0x02\r
+               #define MIDI_JACKTYPE_EXTERNAL      0x02\r
 \r
                /** MIDI command for a note on (activation) event */\r
                #define MIDI_COMMAND_NOTE_ON        0x09\r
@@ -56,7 +76,7 @@
                /** MIDI command for a note off (deactivation) event */\r
                #define MIDI_COMMAND_NOTE_OFF       0x08\r
 \r
-               /** Standard key press velocity value used for all note events, as no pressure sensor is mounted */\r
+               /** Standard key press velocity value used for all note events */\r
                #define MIDI_STANDARD_VELOCITY      64\r
                \r
                /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel\r
@@ -137,7 +157,7 @@
 \r
                typedef struct\r
                {\r
-                       uint8_t  InterfaceNumber;\r
+                       uint8_t  StreamingInterfaceNumber;\r
 \r
                        uint8_t  DataINEndpointNumber;\r
                        uint16_t DataINEndpointSize;\r
@@ -150,9 +170,17 @@
                \r
        /* Function Prototypes: */\r
                bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
+               void USB_MIDI_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
                void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
 \r
                void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
                bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
 \r
+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
+               #endif\r
+               \r
 #endif\r
+\r
+/** @} */\r