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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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/MIDIClassDevice.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/MIDIClassCommon.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                                 struct
  81                                 {
  82                                         uint8_t  StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */
  83
  84                                         USB_Endpoint_Table_t DataINEndpoint; /**< Data IN endpoint configuration table. */
  85                                         USB_Endpoint_Table_t DataOUTEndpoint; /**< Data OUT endpoint configuration table. */
  86                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  87                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  88                                            */
  89
  90                                 struct
  91                                 {
  92                                         uint8_t RESERVED; // No state information for this class
  93                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  94                                           *   are reset to their defaults when the interface is enumerated.
  95                                           */
  96                         } USB_ClassInfo_MIDI_Device_t;
  97
  98                 /* Function Prototypes: */
  99                         /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library
 100                          *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
 101                          *  containing the given MIDI interface is selected.
 102                          *
 103                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 104                          *
 105                          *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
 106                          */
 107                         bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 108
 109                         /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should
 110                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 111                          *
 112                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 113                          */
 114                         void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 115
 116                         /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. Events are queued into the
 117                          *  endpoint bank until either the endpoint bank is full, or \ref MIDI_Device_Flush() is called. This allows for multiple
 118                          *  MIDI events to be packed into a single endpoint packet, increasing data throughput.
 119                          *
 120                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 121                          *       call will fail.
 122                          *
 123                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 124                          *  \param[in]     Event              Pointer to a populated \ref MIDI_EventPacket_t structure containing the MIDI event to send.
 125                          *
 126                          *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
 127                          */
 128                         uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,
 129                                                             const MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 130
 131
 132                         /** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the
 133                          *  \ref MIDI_Device_SendEventPacket() function's packing behavior, to flush queued events.
 134                          *
 135                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 136                          *
 137                          *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
 138                          */
 139                         uint8_t MIDI_Device_Flush(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 140
 141                         /** Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains
 142                          *  multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event.
 143                          *
 144                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 145                          *       call will fail.
 146                          *
 147                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 148                          *  \param[out]    Event              Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed.
 149                          *
 150                          *  \return Boolean \c true if a MIDI event packet was received, \c false otherwise.
 151                          */
 152                         bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,
 153                                                             MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 154
 155                 /* Inline Functions: */
 156                         /** Processes incoming control requests from the host, that are directed to the given MIDI class interface. This should be
 157                          *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.
 158                          *
 159                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 160                          */
 161                         static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 162                         static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo)
 163                         {
 164                                 (void)MIDIInterfaceInfo;
 165                         }
 166
 167         /* Disable C linkage for C++ Compilers: */
 168                 #if defined(__cplusplus)
 169                         }
 170                 #endif
 171
 172 #endif
 173
 174 /** @} */
 175