LUFA/Drivers/USB/Class/Host/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_USBClassMIDIHost MIDI Class Host 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/Host/MIDI.c
  37  *
  38  *  \section Module Description
  39  *  Host Mode USB Class driver framework interface, for the MIDI USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef __MIDI_CLASS_HOST_H__
  45 #define __MIDI_CLASS_HOST_H__
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/MIDI.h"
  50
  51         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Public Interface - May be used in end-application: */
  57                 /* Type Defines: */
  58                         /** Class state structure. An instance of this structure should be made within the user application,
  59                          *  and passed to each of the MIDI class driver functions as the MIDIInterfaceInfo parameter. This
  60                          *  stores each MIDI interface's configuration and state information.
  61                          */
  62                         typedef struct
  63                         {
  64                                 const struct
  65                                 {
  66                                         uint8_t  DataINPipeNumber; /**< Pipe number of the MIDI interface's streaming IN data pipe */
  67                                         bool     DataINPipeDoubleBank; /** Indicates if the MIDI interface's IN data pipe should use double banking */
  68
  69                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the MIDI interface's streaming OUT data pipe */
  70                                         bool     DataOUTPipeDoubleBank; /** Indicates if the MIDI interface's OUT data pipe should use double banking */
  71                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  72                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  73                                            */
  74                                 struct
  75                                 {
  76                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  77                                                         *   after \ref MIDI_Host_ConfigurePipes() is called and the Host state machine is in the
  78                                                         *   Configured state
  79                                                         */
  80
  81                                         uint16_t DataINPipeSize; /**< Size in bytes of the MIDI Streaming Data interface's IN data pipe */
  82                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the MIDI Streaming Data interface's OUT data pipe */
  83                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  84                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  85                                                   *   the interface is enumerated.
  86                                                   */
  87                         } USB_ClassInfo_MIDI_Host_t;
  88
  89                 /* Enums: */
  90                         /** Enum for the possible error codes returned by the \ref MIDI_Host_ConfigurePipes() function. */
  91                         enum MIDIHost_EnumerationFailure_ErrorCodes_t
  92                         {
  93                                 MIDI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
  94                                 MIDI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
  95                                 MIDI_ENUMERROR_NoStreamingInterfaceFound  = 2, /**< A compatible MIDI interface was not found in the device's Configuration Descriptor */
  96                                 MIDI_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible MIDI data endpoints were not found in the device's MIDI interface */
  97                         };
  98
  99                 /* Function Prototypes: */
 100                         /** General management task for a given MIDI host class interface, required for the correct operation of the interface. This should
 101                          *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 102                          *
 103                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing an MIDI Class host configuration and state
 104                          */
 105                         void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 106
 107                         /** Host interface configuration routine, to configure a given MIDI host interface instance using the Configuration
 108                          *  Descriptor read from an attached USB device. This function automatically updates the given MIDI Host instance's
 109                          *  state values and configures the pipes required to communicate with the interface if it is found within the device.
 110                          *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
 111                          *  the Addressed state.
 112                          *
 113                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing an MIDI Class host configuration and state
 114                          *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
 115                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 116                          *
 117                          *  \return A value from the \ref MIDIHost_EnumerationFailure_ErrorCodes_t enum
 118                          */
 119                         uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, uint16_t ConfigDescriptorSize,
 120                                                          void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 121
 122                         /** Sends a MIDI event packet to the device. If no device is connected, the event packet is discarded.
 123                          *
 124                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 125                          *        call will fail.
 126                          *
 127                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
 128                          *  \param[in] Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
 129                          *
 130                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
 131                          */
 132                         uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
 133                                                           MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 134
 135                         /** Receives a MIDI event packet from the device.
 136                          *
 137                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 138                          *        call will fail.
 139                          *
 140                          *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
 141                          *  \param[out] Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed
 142                          *
 143                          *  \return Boolean true if a MIDI event packet was received, false otherwise
 144                          */
 145                         bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
 146                                                           MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 147
 148         /* Private Interface - For use in library only: */
 149         #if !defined(__DOXYGEN__)
 150                 /* Macros: */
 151                         #define MIDI_STREAMING_CLASS           0x01
 152                         #define MIDI_STREAMING_SUBCLASS        0x03
 153                         #define MIDI_STREAMING_PROTOCOL        0x00
 154
 155                         #define MIDI_FOUND_DATAPIPE_IN           (1 << 0)
 156                         #define MIDI_FOUND_DATAPIPE_OUT          (1 << 1)
 157
 158                 /* Function Prototypes: */
 159                         #if defined(INCLUDE_FROM_MIDI_CLASS_HOST_C)
 160                                 static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 161                                 static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 162                         #endif
 163         #endif
 164
 165         /* Disable C linkage for C++ Compilers: */
 166                 #if defined(__cplusplus)
 167                         }
 168                 #endif
 169
 170 #endif
 171
 172 /** @} */