Add MIDI class driver, update MIDI device demo to use the new USB class driver. All device demos/projects have now been converted to the new library class drivers, although documentation is yet to be completed.

1 files changed, 158 insertions, 0 deletions

diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h
new file mode 100644
index 000000000..17823938c
--- /dev/null
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -0,0 +1,158 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2009.

+              

+  dean [at] fourwalledcubicle [dot] com

+      www.fourwalledcubicle.com

+*/

+

+/*

+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

+

+  Permission to use, copy, modify, and distribute this software

+  and its documentation for any purpose and without fee is hereby

+  granted, 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.

+*/

+

+#ifndef _MIDI_CLASS_H_

+#define _MIDI_CLASS_H_

+

+	/* Includes: */

+		#include "../../USB.h"

+		#include "Audio.h"

+

+		#include <string.h>

+

+	/* Macros: */

+		/** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */

+		#define DSUBTYPE_InputJack          0x02

+

+		/** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */

+		#define DSUBTYPE_OutputJack         0x03

+		

+		/** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */

+		#define JACKTYPE_EMBEDDED           0x01

+

+		/** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */

+		#define JACKTYPE_EXTERNAL           0x02

+

+		/** MIDI command for a note on (activation) event */

+		#define MIDI_COMMAND_NOTE_ON        0x09

+

+		/** MIDI command for a note off (deactivation) event */

+		#define MIDI_COMMAND_NOTE_OFF       0x08

+

+		/** Standard key press velocity value used for all note events, as no pressure sensor is mounted */

+		#define MIDI_STANDARD_VELOCITY      64

+		

+		/** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel

+		 *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.

+		 *

+		 *  \param channel  MIDI channel number to address

+		 */

+		#define MIDI_CHANNEL(channel)        (channel - 1)

+		

+	/* Type Defines: */

+		/** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host

+		 *  how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.

+		 *  See the USB Audio specification for more details.

+		 */

+		typedef struct

+		{

+			USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */

+			uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */

+			

+			uint16_t                  AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */

+			uint16_t                  TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */

+		} USB_AudioInterface_MIDI_AS_t;

+		

+		/** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either

+		 *  a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).

+		 */

+		typedef struct

+		{

+			USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */

+			uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */

+

+			uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */

+			uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */

+			

+			uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */

+		} USB_MIDI_In_Jack_t;

+

+		/** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either

+		 *  a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).

+		 */

+		typedef struct

+		{

+			USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */

+			uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */

+

+			uint8_t                   JackType; /**< Type of jack, one of the JACKTYPE_* mask values */

+			uint8_t                   JackID; /**< ID value of this jack - must be a unique value within the device */

+			

+			uint8_t                   NumberOfPins; /**< Number of output channels within the jack, either physical or logical */

+			uint8_t                   SourceJackID[1]; /**< ID of each output pin's source data jack */

+			uint8_t                   SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */

+			

+			uint8_t                   JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */

+		} USB_MIDI_Out_Jack_t;

+		

+		/** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information

+		 *  on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio

+		 *  class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.

+		 */

+		typedef struct

+		{

+			USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length */

+			uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */

+

+			uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */

+			uint8_t                   AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */

+		} USB_MIDI_Jack_Endpoint_t;

+

+		typedef struct

+		{

+			unsigned char Command     : 4;

+			unsigned char CableNumber : 4;

+			

+			uint8_t Data1;

+			uint8_t Data2;

+			uint8_t Data3;			

+		} USB_MIDI_EventPacket_t;

+

+		typedef struct

+		{

+			uint8_t  InterfaceNumber;

+

+			uint8_t  DataINEndpointNumber;

+			uint16_t DataINEndpointSize;

+

+			uint8_t  DataOUTEndpointNumber;

+			uint16_t DataOUTEndpointSize;

+

+			bool     InterfaceEnabled;

+		} USB_ClassInfo_MIDI_t;

+		

+	/* Function Prototypes: */

+		bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);

+		void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);

+

+		void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);

+		bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);

+

+#endif