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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 /** \file
  32  *  \brief Device mode driver for the library USB MIDI Class driver.
  33  *
  34  *  Device mode driver for the library USB MIDI Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.h.
  38  */
  39
  40 /** \ingroup Group_USBClassMIDI
  41  *  \defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Device/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Device Mode USB Class driver framework interface, for the MIDI USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef _MIDI_CLASS_DEVICE_H_
  54 #define _MIDI_CLASS_DEVICE_H_
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/MIDI.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_MIDI_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Type Define: */
  72                         /** \brief MIDI Class Device Mode Configuration and State Structure.
  73                          *
  74                          *  Class state structure. An instance of this structure should be made for each MIDI interface
  75                          *  within the user application, and passed to each of the MIDI class driver functions as the
  76                          *  \c MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.
  77                          */
  78                         typedef struct
  79                         {
  80                                 const struct
  81                                 {
  82                                         uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */
  83
  84                                         uint8_t  DataINEndpointNumber; /**< Endpoint number of the incoming MIDI data, if available (zero if unused). */
  85                                         uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI data endpoint, if available (zero if unused). */
  86                                         bool     DataINEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */
  87
  88                                         uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused). */
  89                                         uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused). */
  90                                         bool     DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */
  91                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  92                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  93                                            */
  94                                 struct
  95                                 {
  96                                         // No state information for this class
  97                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  98                                           *   are reset to their defaults when the interface is enumerated.
  99                                           */
 100                         } USB_ClassInfo_MIDI_Device_t;
 101
 102                 /* Function Prototypes: */
 103                         /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library
 104                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 105                          *  containing the given MIDI interface is selected.
 106                          *
 107                          *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
 108                          *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
 109                          *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
 110                          *
 111                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 112                          *
 113                          *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
 114                          */
 115                         bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 116
 117                         /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should
 118                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 119                          *
 120                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 121                          */
 122                         void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 123
 124                         /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. Events are queued into the
 125                          *  endpoint bank until either the endpoint bank is full, or \ref MIDI_Device_Flush() is called. This allows for multiple
 126                          *  MIDI events to be packed into a single endpoint packet, increasing data throughput.
 127                          *
 128                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 129                          *       call will fail.
 130                          *
 131                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 132                          *  \param[in]     Event              Pointer to a populated \ref MIDI_EventPacket_t structure containing the MIDI event to send.
 133                          *
 134                          *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
 135                          */
 136                         uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,
 137                                                             const MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 138
 139
 140                         /** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the
 141                          *  \ref MIDI_Device_SendEventPacket() function's packing behaviour, to flush queued events.
 142                          *
 143                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 144                          *
 145                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 146                          */
 147                         uint8_t MIDI_Device_Flush(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 148
 149                         /** Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains
 150                          *  multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event.
 151                          *
 152                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 153                          *       call will fail.
 154                          *
 155                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 156                          *  \param[out]    Event              Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed.
 157                          *
 158                          *  \return Boolean \c true if a MIDI event packet was received, \c false otherwise.
 159                          */
 160                         bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,
 161                                                             MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 162
 163                 /* Inline Functions: */
 164                         /** Processes incoming control requests from the host, that are directed to the given MIDI class interface. This should be
 165                          *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
 166                          *
 167                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 168                          */
 169                         static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 170                         static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo)
 171                         {
 172                                 (void)MIDIInterfaceInfo;
 173                         }
 174
 175         /* Disable C linkage for C++ Compilers: */
 176                 #if defined(__cplusplus)
 177                         }
 178                 #endif
 179
 180 #endif
 181
 182 /** @} */
 183