LUFA/Drivers/USB/Class/Device/MIDI.h

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