Add makefile template for the AVR32 UC3 architecture.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / MIDI.c
index 3cb0df6..d376a30 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-#include "../../HighLevel/USBMode.h"\r
-#if defined(USB_CAN_BE_HOST)\r
-\r
-#define  INCLUDE_FROM_MIDI_CLASS_HOST_C\r
-#include "MIDI.h"\r
-\r
-uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, uint16_t ConfigDescriptorSize,\r
-                                 void* ConfigDescriptorData)\r
-{\r
-       uint8_t FoundEndpoints = 0;\r
-\r
-       memset(&MIDIInterfaceInfo->State, 0x00, sizeof(MIDIInterfaceInfo->State));\r
-\r
-       if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
-         return MIDI_ENUMERROR_InvalidConfigDescriptor;\r
-       \r
-       if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
-                                     DComp_MIDI_Host_NextMIDIStreamingInterface) != DESCRIPTOR_SEARCH_COMP_Found)\r
-       {\r
-               return MIDI_ENUMERROR_NoStreamingInterfaceFound;\r
-       }\r
-       \r
-       while (FoundEndpoints != (MIDI_FOUND_DATAPIPE_IN | MIDI_FOUND_DATAPIPE_OUT))\r
-       {\r
-               if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
-                                             DComp_MIDI_Host_NextMIDIStreamingDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r
-               {\r
-                       return MIDI_ENUMERROR_EndpointsNotFound;\r
-               }\r
-               \r
-               USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);\r
-\r
-               if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
-               {\r
-                       Pipe_ConfigurePipe(MIDIInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_IN,\r
-                                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,\r
-                                                          MIDIInterfaceInfo->Config.DataINPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);\r
-                       MIDIInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;\r
-                       \r
-                       FoundEndpoints |= MIDI_FOUND_DATAPIPE_IN;\r
-               }\r
-               else\r
-               {\r
-                       Pipe_ConfigurePipe(MIDIInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_BULK, PIPE_TOKEN_OUT,\r
-                                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,\r
-                                                          MIDIInterfaceInfo->Config.DataOUTPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);\r
-                       MIDIInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;\r
-\r
-                       FoundEndpoints |= MIDI_FOUND_DATAPIPE_OUT;\r
-               }\r
-       }\r
-       \r
-       MIDIInterfaceInfo->State.IsActive = true;\r
-       return MIDI_ENUMERROR_NoError;\r
-}\r
-\r
-static uint8_t DComp_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor)\r
-{\r
-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
-       {\r
-               USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,\r
-                                                                               USB_Descriptor_Interface_t);\r
-\r
-               if ((CurrentInterface->Class    == MIDI_STREAMING_CLASS)    &&\r
-                   (CurrentInterface->SubClass == MIDI_STREAMING_SUBCLASS) &&\r
-                   (CurrentInterface->Protocol == MIDI_STREAMING_PROTOCOL))\r
-               {\r
-                       return DESCRIPTOR_SEARCH_Found;\r
-               }\r
-       }\r
-       \r
-       return DESCRIPTOR_SEARCH_NotFound;\r
-}\r
-\r
-static uint8_t DComp_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor)\r
-{\r
-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
-       {\r
-               USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,\r
-                                                                             USB_Descriptor_Endpoint_t);\r
-       \r
-               uint8_t EndpointType = (CurrentEndpoint->Attributes & EP_TYPE_MASK);\r
-       \r
-               if ((EndpointType == EP_TYPE_BULK) && !(Pipe_IsEndpointBound(CurrentEndpoint->EndpointAddress)))\r
-                 return DESCRIPTOR_SEARCH_Found;\r
-       }\r
-       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
-       {\r
-               return DESCRIPTOR_SEARCH_Fail;\r
-       }\r
-\r
-       return DESCRIPTOR_SEARCH_NotFound;\r
-}\r
-\r
-uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event)\r
-{\r
-       if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))\r
-         return HOST_SENDCONTROL_DeviceDisconnected;\r
-       \r
-       Pipe_SelectPipe(MIDIInterfaceInfo->Config.DataOUTPipeNumber);\r
-\r
-       if (Pipe_IsReadWriteAllowed())\r
-       {\r
-               uint8_t ErrorCode;\r
-\r
-               if ((ErrorCode = Pipe_Write_Stream_LE(Event, sizeof(MIDI_EventPacket_t), NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)\r
-                 return ErrorCode;\r
-\r
-               Pipe_ClearOUT();\r
-       }\r
-       \r
-       return PIPE_RWSTREAM_NoError;\r
-}\r
-\r
-bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo, MIDI_EventPacket_t* const Event)\r
-{\r
-       if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))\r
-         return HOST_SENDCONTROL_DeviceDisconnected;\r
-       \r
-       Pipe_SelectPipe(MIDIInterfaceInfo->Config.DataINPipeNumber);\r
-\r
-       if (!(Pipe_IsReadWriteAllowed()))\r
-         return false;\r
-\r
-       Pipe_Read_Stream_LE(Event, sizeof(MIDI_EventPacket_t), NO_STREAM_CALLBACK);\r
-       Pipe_ClearIN();\r
-       \r
-       return true;\r
-}\r
-\r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+#define  __INCLUDE_FROM_USB_DRIVER
+#include "../../Core/USBMode.h"
+
+#if defined(USB_CAN_BE_HOST)
+
+#define  __INCLUDE_FROM_MIDI_DRIVER
+#define  __INCLUDE_FROM_MIDI_HOST_C
+#include "MIDI.h"
+
+uint8_t MIDI_Host_ConfigurePipes(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
+                                 uint16_t ConfigDescriptorSize,
+                                 void* ConfigDescriptorData)
+{
+       USB_Descriptor_Endpoint_t*  DataINEndpoint  = NULL;
+       USB_Descriptor_Endpoint_t*  DataOUTEndpoint = NULL;
+       USB_Descriptor_Interface_t* MIDIInterface   = NULL;
+
+       memset(&MIDIInterfaceInfo->State, 0x00, sizeof(MIDIInterfaceInfo->State));
+
+       if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
+         return MIDI_ENUMERROR_InvalidConfigDescriptor;
+
+       while (!(DataINEndpoint) || !(DataOUTEndpoint))
+       {
+               if (!(MIDIInterface) ||
+                   USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
+                                             DCOMP_MIDI_Host_NextMIDIStreamingDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
+               {
+                       if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
+                                                     DCOMP_MIDI_Host_NextMIDIStreamingInterface) != DESCRIPTOR_SEARCH_COMP_Found)
+                       {
+                               return MIDI_ENUMERROR_NoCompatibleInterfaceFound;
+                       }
+
+                       MIDIInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);
+
+                       DataINEndpoint  = NULL;
+                       DataOUTEndpoint = NULL;
+
+                       continue;
+               }
+
+               USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
+
+               if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
+                 DataINEndpoint  = EndpointData;
+               else
+                 DataOUTEndpoint = EndpointData;
+       }
+
+       for (uint8_t PipeNum = 1; PipeNum < PIPE_TOTAL_PIPES; PipeNum++)
+       {
+               uint16_t Size;
+               uint8_t  Type;
+               uint8_t  Token;
+               uint8_t  EndpointAddress;
+               bool     DoubleBanked;
+
+               if (PipeNum == MIDIInterfaceInfo->Config.DataINPipeNumber)
+               {
+                       Size            = DataINEndpoint->EndpointSize;
+                       EndpointAddress = DataINEndpoint->EndpointAddress;
+                       Token           = PIPE_TOKEN_IN;
+                       Type            = EP_TYPE_BULK;
+                       DoubleBanked    = MIDIInterfaceInfo->Config.DataINPipeDoubleBank;
+
+                       MIDIInterfaceInfo->State.DataINPipeSize = DataINEndpoint->EndpointSize;
+               }
+               else if (PipeNum == MIDIInterfaceInfo->Config.DataOUTPipeNumber)
+               {
+                       Size            = DataOUTEndpoint->EndpointSize;
+                       EndpointAddress = DataOUTEndpoint->EndpointAddress;
+                       Token           = PIPE_TOKEN_OUT;
+                       Type            = EP_TYPE_BULK;
+                       DoubleBanked    = MIDIInterfaceInfo->Config.DataOUTPipeDoubleBank;
+
+                       MIDIInterfaceInfo->State.DataOUTPipeSize = DataOUTEndpoint->EndpointSize;
+               }
+               else
+               {
+                       continue;
+               }
+
+               if (!(Pipe_ConfigurePipe(PipeNum, Type, Token, EndpointAddress, Size,
+                                        DoubleBanked ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE)))
+               {
+                       return MIDI_ENUMERROR_PipeConfigurationFailed;
+               }
+       }
+
+       MIDIInterfaceInfo->State.InterfaceNumber = MIDIInterface->InterfaceNumber;
+       MIDIInterfaceInfo->State.IsActive = true;
+
+       return MIDI_ENUMERROR_NoError;
+}
+
+static uint8_t DCOMP_MIDI_Host_NextMIDIStreamingInterface(void* const CurrentDescriptor)
+{
+       USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+       if (Header->Type == DTYPE_Interface)
+       {
+               USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
+
+               if ((Interface->Class    == AUDIO_CSCP_AudioClass)            &&
+                   (Interface->SubClass == AUDIO_CSCP_MIDIStreamingSubclass) &&
+                   (Interface->Protocol == AUDIO_CSCP_StreamingProtocol))
+               {
+                       return DESCRIPTOR_SEARCH_Found;
+               }
+       }
+
+       return DESCRIPTOR_SEARCH_NotFound;
+}
+
+static uint8_t DCOMP_MIDI_Host_NextMIDIStreamingDataEndpoint(void* const CurrentDescriptor)
+{
+       USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+       if (Header->Type == DTYPE_Endpoint)
+       {
+               USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);
+
+               uint8_t EndpointType = (Endpoint->Attributes & EP_TYPE_MASK);
+
+               if ((EndpointType == EP_TYPE_BULK) && !(Pipe_IsEndpointBound(Endpoint->EndpointAddress)))
+                 return DESCRIPTOR_SEARCH_Found;
+       }
+       else if (Header->Type == DTYPE_Interface)
+       {
+               return DESCRIPTOR_SEARCH_Fail;
+       }
+
+       return DESCRIPTOR_SEARCH_NotFound;
+}
+
+void MIDI_Host_USBTask(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo)
+{
+       if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))
+         return;
+
+       #if !defined(NO_CLASS_DRIVER_AUTOFLUSH)
+       MIDI_Host_Flush(MIDIInterfaceInfo);
+       #endif  
+}
+
+uint8_t MIDI_Host_Flush(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo)
+{
+       if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))
+         return PIPE_RWSTREAM_DeviceDisconnected;
+
+       uint8_t ErrorCode;
+
+       Pipe_SelectPipe(MIDIInterfaceInfo->Config.DataOUTPipeNumber);
+
+       if (Pipe_BytesInPipe())
+       {
+               Pipe_ClearOUT();
+
+               if ((ErrorCode = Pipe_WaitUntilReady()) != PIPE_READYWAIT_NoError)
+                 return ErrorCode;
+       }
+
+       return PIPE_READYWAIT_NoError;
+}
+
+uint8_t MIDI_Host_SendEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
+                                  MIDI_EventPacket_t* const Event)
+{
+       if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))
+         return HOST_SENDCONTROL_DeviceDisconnected;
+
+       uint8_t ErrorCode;
+
+       Pipe_SelectPipe(MIDIInterfaceInfo->Config.DataOUTPipeNumber);
+
+       if ((ErrorCode = Pipe_Write_Stream_LE(Event, sizeof(MIDI_EventPacket_t), NULL)) != PIPE_RWSTREAM_NoError)
+         return ErrorCode;
+
+       if (!(Pipe_IsReadWriteAllowed()))
+         Pipe_ClearOUT();
+
+       return PIPE_RWSTREAM_NoError;
+}
+
+bool MIDI_Host_ReceiveEventPacket(USB_ClassInfo_MIDI_Host_t* const MIDIInterfaceInfo,
+                                  MIDI_EventPacket_t* const Event)
+{
+       if ((USB_HostState != HOST_STATE_Configured) || !(MIDIInterfaceInfo->State.IsActive))
+         return HOST_SENDCONTROL_DeviceDisconnected;
+
+       Pipe_SelectPipe(MIDIInterfaceInfo->Config.DataINPipeNumber);
+
+       if (!(Pipe_IsReadWriteAllowed()))
+         return false;
+
+       Pipe_Read_Stream_LE(Event, sizeof(MIDI_EventPacket_t), NULL);
+
+       if (!(Pipe_IsReadWriteAllowed()))
+         Pipe_ClearIN();
+
+       return true;
+}
+
+#endif
+