MIDI.h 8.05 KB
 Dean Camera committed Oct 08, 2009 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 /* LUFA Library Copyright (C) Dean Camera, 2009. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, 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. */ /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDIHost MIDI Class Host 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/Host/MIDI.c * * \section Module Description * Host Mode USB Class driver framework interface, for the MIDI USB Class driver. * * @{ */ #ifndef __MIDI_CLASS_HOST_H__ #define __MIDI_CLASS_HOST_H__ /* Includes: */ #include "../../USB.h" #include "../Common/MIDI.h" /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif /* Public Interface - May be used in end-application: */ /* Type Defines: */ /** Class state structure. An instance of this structure should be made 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 { uint8_t DataINPipeNumber; /**< Pipe number of the MIDI interface's streaming IN data pipe */  Dean Camera committed Nov 07, 2009 67 68  bool DataINPipeDoubleBank; /** Indicates if the MIDI interface's IN data pipe should use double banking */  Dean Camera committed Oct 08, 2009 69  uint8_t DataOUTPipeNumber; /**< Pipe number of the MIDI interface's streaming OUT data pipe */  Dean Camera committed Nov 07, 2009 70  bool DataOUTPipeDoubleBank; /** Indicates if the MIDI interface's OUT data pipe should use double banking */  Dean Camera committed Oct 08, 2009 71 72 73 74 75 76  } 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 { bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid  Dean Camera committed Nov 04, 2009 77  * after \ref MIDI_Host_ConfigurePipes() is called and the Host state machine is in the  Dean Camera committed Oct 08, 2009 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119  * Configured state */ uint16_t DataINPipeSize; /**< Size in bytes of the MIDI Streaming Data interface's IN data pipe */ uint16_t DataOUTPipeSize; /**< Size in bytes of the MIDI Streaming Data interface's OUT data pipe */ } State; /**< State data for the USB class interface within the device. All elements in this section * may be set to initial values, but may also be ignored to default to sane values when * the interface is enumerated. */ } USB_ClassInfo_MIDI_Host_t; /* Enums: */ /** Enum for the possible error codes returned by the \ref MIDI_Host_ConfigurePipes() function. */ enum MIDIHost_EnumerationFailure_ErrorCodes_t { MIDI_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */ MIDI_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */ MIDI_ENUMERROR_NoStreamingInterfaceFound = 2, /**< A compatible MIDI interface was not found in the device's Configuration Descriptor */ MIDI_ENUMERROR_EndpointsNotFound = 3, /**< Compatible MIDI data endpoints were not found in the device's MIDI interface */ }; /* Function Prototypes: */ /** General management task for a given MIDI host 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[in,out] MIDIInterfaceInfo Pointer to a structure containing an MIDI Class host configuration and state */ void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); /** Host interface configuration routine, to configure a given MIDI host interface instance using the Configuration * Descriptor read from an attached USB device. This function automatically updates the given MIDI Host instance's * state values and configures the pipes required to communicate with the interface if it is found within the device. * This should be called once after the stack has enumerated the attached device, while the host state machine is in * the Addressed state. * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing an MIDI Class host configuration and state * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor * * \return A value from the \ref MIDIHost_EnumerationFailure_ErrorCodes_t enum */ uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, uint16_t ConfigDescriptorSize,  Dean Camera committed Nov 07, 2009 120  void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);  Dean Camera committed Oct 08, 2009 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153  /** Sends a MIDI event packet to the device. If no device is connected, the event packet is discarded. * * \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 * * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum */ uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1, 2); /** Receives a MIDI event packet from the device. * * \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 * * \return Boolean true if a MIDI event packet was received, false otherwise */ bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1, 2); /* Private Interface - For use in library only: */ #if !defined(__DOXYGEN__) /* Macros: */ #define MIDI_STREAMING_CLASS 0x01 #define MIDI_STREAMING_SUBCLASS 0x03 #define MIDI_STREAMING_PROTOCOL 0x00 #define MIDI_FOUND_DATAPIPE_IN (1 << 0) #define MIDI_FOUND_DATAPIPE_OUT (1 << 1) /* Function Prototypes: */ #if defined(INCLUDE_FROM_MIDI_CLASS_HOST_C)  Dean Camera committed Nov 03, 2009 154 155  static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1); static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);  Dean Camera committed Oct 08, 2009 156 157 158 159 160 161 162 163 164 165 166  #endif #endif /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif #endif /** @} */