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