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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 Module Description
  35  *  Device Mode USB Class driver framework interface, for the MIDI USB Class driver.
  36  *
  37  *  @{
  38  */
  39
  40 #ifndef _MIDI_CLASS_DEVICE_H_
  41 #define _MIDI_CLASS_DEVICE_H_
  42
  43         /* Includes: */
  44                 #include "../../USB.h"
  45                 #include "../Common/MIDI.h"
  46                 #include "Audio.h"
  47
  48                 #include <string.h>
  49
  50         /* Enable C linkage for C++ Compilers: */
  51                 #if defined(__cplusplus)
  52                         extern "C" {
  53                 #endif
  54
  55         /* Public Interface - May be used in end-application: */
  56                 /* Type Define: */
  57                         /** Configuration information structure for \ref USB_ClassInfo_MIDI_Device_t MIDI device interface structures. */
  58                         typedef struct
  59                         {
  60                                 uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */
  61
  62                                 uint8_t  DataINEndpointNumber; /**< Endpoint number of the incomming MIDI data, if available (zero if unused) */
  63                                 uint16_t DataINEndpointSize; /**< Size in bytes of the incomming MIDI data endpoint, if available (zero if unused) */
  64
  65                                 uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused) */
  66                                 uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused) */
  67                         } USB_ClassInfo_MIDI_Device_Config_t;
  68
  69                         /** Current State information structure for \ref USB_ClassInfo_MIDI_Device_t MIDI device interface structures. */
  70                         typedef struct
  71                         {
  72
  73                         } USB_ClassInfo_MIDI_Device_State_t;
  74
  75                         /** Class state structure. An instance of this structure should be made for each MIDI interface
  76                          *  within the user application, and passed to each of the MIDI class driver functions as the
  77                          *  MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.
  78                          */
  79                         typedef struct
  80                         {
  81                                 const USB_ClassInfo_MIDI_Device_Config_t Config; /**< Config data for the USB class interface within
  82                                                                                   *   the device. All elements in this section
  83                                                                                   *   <b>must</b> be set or the interface will fail
  84                                                                                   *   to enumerate and operate correctly.
  85                                                                                   */
  86
  87                                 USB_ClassInfo_MIDI_Device_State_t State; /**< State data for the USB class interface within
  88                                                                           *   the device. All elements in this section
  89                                                                           *   <b>may</b> be set to initial values, but may
  90                                                                           *   also be ignored to default to sane values when
  91                                                                           *   the interface is enumerated.
  92                                                                           */
  93                         } USB_ClassInfo_MIDI_Device_t;
  94
  95                 /* Function Prototypes: */
  96                         /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library
  97                          *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration
  98                          *  containing the given MIDI interface is selected.
  99                          *
 100                          *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 101                          *
 102                          *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
 103                          */
 104                         bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);
 105
 106                         /** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be
 107                          *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
 108                          *
 109                          *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 110                          */
 111                         void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);
 112
 113                         /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should
 114                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 115                          *
 116                          *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 117                          */
 118                         void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);
 119
 120                         /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.
 121                          *
 122                          *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 123                          *  \param Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
 124                          */
 125                         void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);
 126
 127                         /** Receives a MIDI event packet from the host.
 128                          *
 129                          *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 130                          *  \param Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed
 131                          *
 132                          *  \return Boolean true if a MIDI event packet was received, false otherwise
 133                          */
 134                         bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);
 135
 136         /* Disable C linkage for C++ Compilers: */
 137                 #if defined(__cplusplus)
 138                         }
 139                 #endif
 140
 141 #endif
 142
 143 /** @} */