Module Source Dependencies
The following files must be built with any user project that uses this module:
- LUFA/Drivers/USB/Class/Device/MIDIClassDevice.c (Makefile source module name: LUFA_SRC_USBCLASS)
Module Description
Device Mode USB Class driver framework interface, for the MIDI USB Class driver.
Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the given MIDI interface is selected.
- Parameters
-
[in,out] | MIDIInterfaceInfo | Pointer to a structure containing a MIDI Class configuration and state. |
- Returns
- Boolean
true
if the endpoints were successfully configured, false
otherwise.
Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the MIDI_Device_SendEventPacket() function's packing behavior, to flush queued events.
- Parameters
-
[in,out] | MIDIInterfaceInfo | Pointer to a structure containing a MIDI Class configuration and state. |
- Returns
- A value from the Endpoint_WaitUntilReady_ErrorCodes_t enum.
Processes incoming control requests from the host, that are directed to the given MIDI class interface. This should be linked to the library EVENT_USB_Device_ControlRequest() event.
- Parameters
-
[in,out] | MIDIInterfaceInfo | Pointer to a structure containing a MIDI Class configuration and state. |
Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event.
- Precondition
- This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the call will fail.
- Parameters
-
[in,out] | MIDIInterfaceInfo | Pointer to a structure containing a MIDI Class configuration and state. |
[out] | Event | Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed. |
- Returns
- Boolean
true
if a MIDI event packet was received, false
otherwise.
Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. Events are queued into the endpoint bank until either the endpoint bank is full, or MIDI_Device_Flush() is called. This allows for multiple MIDI events to be packed into a single endpoint packet, increasing data throughput.
- Precondition
- This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the call will fail.
- Parameters
-
[in,out] | MIDIInterfaceInfo | Pointer to a structure containing a MIDI Class configuration and state. |
[in] | Event | Pointer to a populated MIDI_EventPacket_t structure containing the MIDI event to send. |
- Returns
- A value from the Endpoint_Stream_RW_ErrorCodes_t enum.
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 USB_USBTask().
- Parameters
-
[in,out] | MIDIInterfaceInfo | Pointer to a structure containing a MIDI Class configuration and state. |