aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Class/Host/MIDI.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2010-01-05 13:52:34 +0000
committerDean Camera <dean@fourwalledcubicle.com>2010-01-05 13:52:34 +0000
commitd97db1120b2b5911a3ea7d77efb9b913b8727bdb (patch)
treec51e1ddfab5f8c53f95db8016e0eaefc2cf9c36d /LUFA/Drivers/USB/Class/Host/MIDI.h
parent60e96412220b62a614348c287354c56f282fcc70 (diff)
downloadlufa-d97db1120b2b5911a3ea7d77efb9b913b8727bdb.tar.gz
lufa-d97db1120b2b5911a3ea7d77efb9b913b8727bdb.tar.bz2
lufa-d97db1120b2b5911a3ea7d77efb9b913b8727bdb.zip
Added support to the MIDI Class drivers for packed data, where multiple MIDI events are packed into a single USB packet. Added new MIDI Class driver flush routines to override packing behaviour.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Host/MIDI.h')
-rw-r--r--LUFA/Drivers/USB/Class/Host/MIDI.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h
index b1971b16d..7b1cba395 100644
--- a/LUFA/Drivers/USB/Class/Host/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Host/MIDI.h
@@ -125,6 +125,17 @@
uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+ /** Flushes the MIDI send buffer, sending any queued MIDI events to the device. This should be called to override the
+ * \ref MIDI_Host_SendEventPacket() function's packing behaviour, to flush queued events. Events are queued into the
+ * pipe bank until either the pipe bank is full, or \ref MIDI_Host_Flush() is called. This allows for multiple MIDI
+ * events to be packed into a single pipe packet, increasing data throughput.
+ *
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state
+ *
+ * \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
+ */
+ uint8_t MIDI_Host_Flush(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo);
+
/** Receives a MIDI event packet from the device.
*
* \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the