X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/afe6ae14023c7040befe73e49d00077d3425c564..c75f8bf2236bc69511d0ff0bc79bfaf1f62e3bfd:/LUFA/Drivers/USB/Class/Device/MIDI.h?ds=sidebyside diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index 0963aab02..87aabe1c5 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -52,46 +52,47 @@ extern "C" { #endif - /* Function Prototypes: */ - /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library - * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration - * containing the given MIDI interface is selected. - * - * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. - * - * \return Boolean true if the endpoints were sucessfully configured, false otherwise - */ - bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo); - - /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be - * linked to the library \ref EVENT_USB_UnhandledControlPacket() event. - * - * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. - */ - void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo); + /* Public Interface - May be used in end-application: */ + /* Function Prototypes: */ + /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library + * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration + * containing the given MIDI interface is selected. + * + * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. + * + * \return Boolean true if the endpoints were sucessfully configured, false otherwise + */ + bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo); + + /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be + * linked to the library \ref EVENT_USB_UnhandledControlPacket() event. + * + * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. + */ + void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo); - /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should - * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask(). - * - * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. - */ - void MIDI_Device_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo); + /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should + * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask(). + * + * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. + */ + void MIDI_Device_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo); - /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. - * - * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. - * \param Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send - */ - void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event); + /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. + * + * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. + * \param Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send + */ + void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event); - /** Receives a MIDI event packet from the host. - * - * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. - * \param Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed - * - * \return Boolean true if a MIDI event packet was received, false otherwise - */ - bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event); + /** Receives a MIDI event packet from the host. + * + * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. + * \param Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed + * + * \return Boolean true if a MIDI event packet was received, false otherwise + */ + bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event); /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus)