LUFA/Drivers/USB/Class/Host/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 Host mode driver for the library USB MIDI Class driver.
  33  *
  34  *  Host 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_USBClassMIDIHost MIDI Class Host 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/Host/MIDI.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription Module Description
  48  *  Host Mode USB Class driver framework interface, for the MIDI USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __MIDI_CLASS_HOST_H__
  54 #define __MIDI_CLASS_HOST_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                 #if defined(__INCLUDE_FROM_MIDI_HOST_C) && defined(NO_STREAM_CALLBACKS)
  71                         #error The NO_STREAM_CALLBACKS compile time option cannot be used in projects using the library Class drivers.
  72                 #endif
  73
  74         /* Public Interface - May be used in end-application: */
  75                 /* Type Defines: */
  76                         /** \brief MIDI Class Host Mode Configuration and State Structure.
  77                          *
  78                          *  Class state structure. An instance of this structure should be made within the user application,
  79                          *  and passed to each of the MIDI class driver functions as the \c MIDIInterfaceInfo parameter. This
  80                          *  stores each MIDI interface's configuration and state information.
  81                          */
  82                         typedef struct
  83                         {
  84                                 const struct
  85                                 {
  86                                         uint8_t  DataINPipeNumber; /**< Pipe number of the MIDI interface's streaming IN data pipe. */
  87                                         bool     DataINPipeDoubleBank; /**< Indicates if the MIDI interface's IN data pipe should use double banking. */
  88
  89                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the MIDI interface's streaming OUT data pipe. */
  90                                         bool     DataOUTPipeDoubleBank; /**< Indicates if the MIDI interface's OUT data pipe 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                                         bool     IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  97                                                             *   after \ref MIDI_Host_ConfigurePipes() is called and the Host state machine is in the
  98                                                             *   Configured state.
  99                                                             */
 100                                         uint8_t  InterfaceNumber; /**< Interface index of the MIDI interface within the attached device. */
 101
 102                                         uint16_t DataINPipeSize; /**< Size in bytes of the MIDI Streaming Data interface's IN data pipe. */
 103                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the MIDI Streaming Data interface's OUT data pipe. */
 104                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 105                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 106                                                   *   the interface is enumerated.
 107                                                   */
 108                         } USB_ClassInfo_MIDI_Host_t;
 109
 110                 /* Enums: */
 111                         /** Enum for the possible error codes returned by the \ref MIDI_Host_ConfigurePipes() function. */
 112                         enum MIDI_Host_EnumerationFailure_ErrorCodes_t
 113                         {
 114                                 MIDI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 115                                 MIDI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 116                                 MIDI_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible MIDI interface was not found in the device's Configuration Descriptor. */
 117                                 MIDI_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
 118                         };
 119
 120                 /* Function Prototypes: */
 121                         /** Host interface configuration routine, to configure a given MIDI host interface instance using the Configuration
 122                          *  Descriptor read from an attached USB device. This function automatically updates the given MIDI Host instance's
 123                          *  state values and configures the pipes required to communicate with the interface if it is found within the device.
 124                          *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
 125                          *  the Addressed state.
 126                          *
 127                          *  \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other
 128                          *        interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes
 129                          *        within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.
 130                          *
 131                          *  \param[in,out] MIDIInterfaceInfo       Pointer to a structure containing an MIDI Class host configuration and state.
 132                          *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
 133                          *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
 134                          *
 135                          *  \return A value from the \ref MIDI_Host_EnumerationFailure_ErrorCodes_t enum.
 136                          */
 137                         uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
 138                                                          uint16_t ConfigDescriptorSize,
 139                                                          void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 140
 141                         /** General management task for a given MIDI host class interface, required for the correct operation of the interface. This should
 142                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 143                          *
 144                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing an MIDI Class host configuration and state.
 145                          */
 146                         void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 147
 148                         /** Sends a MIDI event packet to the device. If no device is connected, the event packet is discarded.
 149                          *
 150                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 151                          *       call will fail.
 152                          *
 153                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 154                          *  \param[in]     Event              Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send.
 155                          *
 156                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
 157                          */
 158                         uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
 159                                                           MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 160
 161                         /** Flushes the MIDI send buffer, sending any queued MIDI events to the device. This should be called to override the
 162                          *  \ref MIDI_Host_SendEventPacket() function's packing behaviour, to flush queued events. Events are queued into the
 163                          *  pipe bank until either the pipe bank is full, or \ref MIDI_Host_Flush() is called. This allows for multiple MIDI
 164                          *  events to be packed into a single pipe packet, increasing data throughput.
 165                          *
 166                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 167                          *
 168                          *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum.
 169                          */
 170                          uint8_t MIDI_Host_Flush(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 171
 172                         /** Receives a MIDI event packet from the device.
 173                          *
 174                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 175                          *       call will fail.
 176                          *
 177                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.
 178                          *  \param[out]    Event              Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed.
 179                          *
 180                          *  \return Boolean \c true if a MIDI event packet was received, \c false otherwise.
 181                          */
 182                         bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
 183                                                           MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 184
 185         /* Private Interface - For use in library only: */
 186         #if !defined(__DOXYGEN__)
 187                 /* Function Prototypes: */
 188                         #if defined(__INCLUDE_FROM_MIDI_HOST_C)
 189                                 static uint8_t DCOMP_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 190                                 static uint8_t DCOMP_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 191                         #endif
 192         #endif
 193
 194         /* Disable C linkage for C++ Compilers: */
 195                 #if defined(__cplusplus)
 196                         }
 197                 #endif
 198
 199 #endif
 200
 201 /** @} */
 202