MIDI.h 8.71 KB
 Dean Camera committed May 08, 2010 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 /* LUFA Library Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */ /** \file * \brief Device mode driver for the library USB MIDI Class driver. * * Device mode driver for the library USB MIDI Class driver. * * \note This file should not be included directly. It is automatically included as needed by the class driver * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. */ /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MIDI.c * * \section Module Description * Device Mode USB Class driver framework interface, for the MIDI USB Class driver. * * @{ */ #ifndef _MIDI_CLASS_DEVICE_H_ #define _MIDI_CLASS_DEVICE_H_ /* Includes: */ #include "../../USB.h" #include "../Common/MIDI.h" #include /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Preprocessor Checks: */ #if !defined(__INCLUDE_FROM_MIDI_DRIVER) #error Do not include this file directly. Include LUFA/Drivers/Class/MIDI.h instead. #endif /* Public Interface - May be used in end-application: */ /* Type Define: */ /** \brief MIDI Class Device Mode Configuration and State Structure. * * Class state structure. An instance of this structure should be made for each MIDI interface * within the user application, and passed to each of the MIDI class driver functions as the * MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information. */ typedef struct { const struct {  Dean Camera committed Jun 17, 2010 84  uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */  Dean Camera committed May 08, 2010 85   Dean Camera committed Jun 17, 2010 86 87 88  uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI data, if available (zero if unused). */ uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI data endpoint, if available (zero if unused). */ bool DataINEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */  Dean Camera committed May 08, 2010 89   Dean Camera committed Jun 17, 2010 90 91 92  uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused). */ uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused). */ bool DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */  Dean Camera committed May 08, 2010 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108  } Config; /**< Config data for the USB class interface within the device. All elements in this section * must be set or the interface will fail to enumerate and operate correctly. */ struct { // No state information for this class yet } State; /**< State data for the USB class interface within the device. All elements in this section * are reset to their defaults when the interface is enumerated. */ } USB_ClassInfo_MIDI_Device_t; /* Function Prototypes: */ /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration * containing the given MIDI interface is selected. *  Dean Camera committed Jun 17, 2010 109  * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.  Dean Camera committed May 08, 2010 110  *  Dean Camera committed Jun 17, 2010 111  * \return Boolean true if the endpoints were successfully configured, false otherwise.  Dean Camera committed May 08, 2010 112 113 114 115 116 117 118  */ bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** 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 \ref MIDI_Device_Flush() is called. This allows for multiple * MIDI events to be packed into a single endpoint packet, increasing data throughput. *  Dean Camera committed Jun 15, 2010 119 120  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 121  *  Dean Camera committed Jun 17, 2010 122 123  * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. * \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send.  Dean Camera committed May 08, 2010 124  *  Dean Camera committed Jun 17, 2010 125  * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 126 127  */ uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,  128  const MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);  Dean Camera committed May 08, 2010 129 130 131  /** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the  Dean Camera committed Jun 16, 2010 132  * \ref MIDI_Device_SendEventPacket() function's packing behavior, to flush queued events.  Dean Camera committed May 08, 2010 133  *  Dean Camera committed Jun 17, 2010 134  * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.  Dean Camera committed May 08, 2010 135  *  Dean Camera committed Jun 17, 2010 136  * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.  Dean Camera committed May 08, 2010 137  */  138  uint8_t MIDI_Device_Flush(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 139 140 141 142  /** 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. *  Dean Camera committed Jun 15, 2010 143 144  * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail.  Dean Camera committed May 08, 2010 145  *  Dean Camera committed Jun 17, 2010 146 147  * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state. * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed.  Dean Camera committed May 08, 2010 148  *  Dean Camera committed Jun 17, 2010 149  * \return Boolean true if a MIDI event packet was received, false otherwise.  Dean Camera committed May 08, 2010 150 151 152 153 154 155 156 157  */ bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); /* Inline Functions: */ /** 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(). *  Dean Camera committed Jun 17, 2010 158  * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.  Dean Camera committed May 08, 2010 159  */  160  static inline void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed May 08, 2010 161 162 163 164 165 166 167 168  static inline void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) { (void)MIDIInterfaceInfo; } /** Processes incoming control requests from the host, that are directed to the given MIDI class interface. This should be * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event. *  Dean Camera committed Jun 17, 2010 169  * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.  Dean Camera committed May 08, 2010 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184  */ static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) { (void)MIDIInterfaceInfo; } /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */