LUFA/Drivers/USB/Class/Host/MIDI.c

   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 #define  __INCLUDE_FROM_USB_DRIVER
  32 #include "../../HighLevel/USBMode.h"
  33 #if defined(USB_CAN_BE_HOST)
  34
  35 #define  __INCLUDE_FROM_MIDI_DRIVER
  36 #define  __INCLUDE_FROM_MIDI_HOST_C
  37 #include "MIDI.h"
  38
  39 uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
  40                                  uint16_t ConfigDescriptorSize,
  41                                  void* ConfigDescriptorData)
  42 {
  43         USB_Descriptor_Endpoint_t*  DataINEndpoint  = NULL;
  44         USB_Descriptor_Endpoint_t*  DataOUTEndpoint = NULL;
  45         USB_Descriptor_Interface_t* MIDIInterface   = NULL;
  46
  47         memset(&MIDIInterfaceInfo->State, 0x00, sizeof(MIDIInterfaceInfo->State));
  48
  49         if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
  50           return MIDI_ENUMERROR_InvalidConfigDescriptor;
  51
  52         while (!(DataINEndpoint) || !(DataOUTEndpoint))
  53         {
  54                 if (!(MIDIInterface) ||
  55                     USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  56                                               DCOMP_MIDI_Host_NextMIDIStreamingDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  57                 {
  58                         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  59                                                       DCOMP_MIDI_Host_NextMIDIStreamingInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  60                         {
  61                                 return MIDI_ENUMERROR_NoCompatibleInterfaceFound;
  62                         }
  63
  64                         MIDIInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);
  65
  66                         DataINEndpoint  = NULL;
  67                         DataOUTEndpoint = NULL;
  68
  69                         continue;
  70                 }
  71
  72                 USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
  73
  74                 if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
  75                   DataINEndpoint  = EndpointData;
  76                 else
  77                   DataOUTEndpoint = EndpointData;
  78         }
  79
  80         for (uint8_t PipeNum = 1; PipeNum < PIPE_TOTAL_PIPES; PipeNum++)
  81         {
  82                 uint16_t Size;
  83                 uint8_t  Type;
  84                 uint8_t  Token;
  85                 uint8_t  EndpointAddress;
  86                 bool     DoubleBanked;
  87
  88                 if (PipeNum == MIDIInterfaceInfo->Config.DataINPipeNumber)
  89                 {
  90                         Size            = DataINEndpoint->EndpointSize;
  91                         EndpointAddress = DataINEndpoint->EndpointAddress;
  92                         Token           = PIPE_TOKEN_IN;
  93                         Type            = EP_TYPE_BULK;
  94                         DoubleBanked    = MIDIInterfaceInfo->Config.DataINPipeDoubleBank;
  95
  96                         MIDIInterfaceInfo->State.DataINPipeSize = DataINEndpoint->EndpointSize;
  97                 }
  98                 else if (PipeNum == MIDIInterfaceInfo->Config.DataOUTPipeNumber)
  99                 {
 100                         Size            = DataOUTEndpoint->EndpointSize;
 101                         EndpointAddress = DataOUTEndpoint->EndpointAddress;
 102                         Token           = PIPE_TOKEN_OUT;
 103                         Type            = EP_TYPE_BULK;
 104                         DoubleBanked    = MIDIInterfaceInfo->Config.DataOUTPipeDoubleBank;
 105
 106                         MIDIInterfaceInfo->State.DataOUTPipeSize = DataOUTEndpoint->EndpointSize;
 107                 }
 108                 else
 109                 {
 110                         continue;
 111                 }
 112
 113                 if (!(Pipe_ConfigurePipe(PipeNum, Type, Token, EndpointAddress, Size,
 114                                          DoubleBanked ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE)))
 115                 {
 116                         return MIDI_ENUMERROR_PipeConfigurationFailed;
 117                 }
 118         }
 119
 120         MIDIInterfaceInfo->State.InterfaceNumber = MIDIInterface->InterfaceNumber;
 121         MIDIInterfaceInfo->State.IsActive = true;
 122
 123         return MIDI_ENUMERROR_NoError;
 124 }
 125
 126 static uint8_t DCOMP_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor)
 127 {
 128         USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
 129
 130         if (Header->Type == DTYPE_Interface)
 131         {
 132                 USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
 133
 134                 if ((Interface->Class    == AUDIO_CSCP_AudioClass)            &&
 135                     (Interface->SubClass == AUDIO_CSCP_MIDIStreamingSubclass) &&
 136                     (Interface->Protocol == AUDIO_CSCP_StreamingProtocol))
 137                 {
 138                         return DESCRIPTOR_SEARCH_Found;
 139                 }
 140         }
 141
 142         return DESCRIPTOR_SEARCH_NotFound;
 143 }
 144
 145 static uint8_t DCOMP_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor)
 146 {
 147         USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
 148
 149         if (Header->Type == DTYPE_Endpoint)
 150         {
 151                 USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);
 152
 153                 uint8_t EndpointType = (Endpoint->Attributes & EP_TYPE_MASK);
 154
 155                 if ((EndpointType == EP_TYPE_BULK) && !(Pipe_IsEndpointBound(Endpoint->EndpointAddress)))
 156                   return DESCRIPTOR_SEARCH_Found;
 157         }
 158         else if (Header->Type == DTYPE_Interface)
 159         {
 160                 return DESCRIPTOR_SEARCH_Fail;
 161         }
 162
 163         return DESCRIPTOR_SEARCH_NotFound;
 164 }
 165
 166 void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo)
 167 {
 168         if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))
 169           return;
 170
 171         #if !defined(NO_CLASS_DRIVER_AUTOFLUSH)
 172         MIDI_Host_Flush(MIDIInterfaceInfo);
 173         #endif
 174 }
 175
 176 uint8_t MIDI_Host_Flush(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo)
 177 {
 178         if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))
 179           return PIPE_RWSTREAM_DeviceDisconnected;
 180
 181         uint8_t ErrorCode;
 182
 183         Pipe_SelectPipe(MIDIInterfaceInfo->Config.DataOUTPipeNumber);
 184
 185         if (Pipe_BytesInPipe())
 186         {
 187                 Pipe_ClearOUT();
 188
 189                 if ((ErrorCode = Pipe_WaitUntilReady()) != PIPE_READYWAIT_NoError)
 190                   return ErrorCode;
 191         }
 192
 193         return PIPE_READYWAIT_NoError;
 194 }
 195
 196 uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
 197                                   MIDI_EventPacket_t* const Event)
 198 {
 199         if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))
 200           return HOST_SENDCONTROL_DeviceDisconnected;
 201
 202         uint8_t ErrorCode;
 203
 204         Pipe_SelectPipe(MIDIInterfaceInfo->Config.DataOUTPipeNumber);
 205
 206         if ((ErrorCode = Pipe_Write_Stream_LE(Event, sizeof(MIDI_EventPacket_t), NULL)) != PIPE_RWSTREAM_NoError)
 207           return ErrorCode;
 208
 209         if (!(Pipe_IsReadWriteAllowed()))
 210           Pipe_ClearOUT();
 211
 212         return PIPE_RWSTREAM_NoError;
 213 }
 214
 215 bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
 216                                   MIDI_EventPacket_t* const Event)
 217 {
 218         if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))
 219           return HOST_SENDCONTROL_DeviceDisconnected;
 220
 221         Pipe_SelectPipe(MIDIInterfaceInfo->Config.DataINPipeNumber);
 222
 223         if (!(Pipe_IsReadWriteAllowed()))
 224           return false;
 225
 226         Pipe_Read_Stream_LE(Event, sizeof(MIDI_EventPacket_t), NULL);
 227
 228         if (!(Pipe_IsReadWriteAllowed()))
 229           Pipe_ClearIN();
 230
 231         return true;
 232 }
 233
 234 #endif
 235