/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\r
\r
dean [at] fourwalledcubicle [dot] com\r
www.fourwalledcubicle.com\r
*/\r
\r
/*\r
- Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- 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
+ 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
this software.\r
*/\r
\r
-/** \ingroup Group_USBDeviceClassDrivers\r
- * @defgroup Group_USBClassMIDIDevice MIDI Device Class Driver - LUFA/Drivers/Class/Device/MIDI.h\r
+/** \ingroup Group_USBClassMIDI\r
+ * @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver\r
*\r
* \section Sec_Dependencies Module Source Dependencies\r
* The following files must be built with any user project that uses this module:\r
* - LUFA/Drivers/USB/Class/Device/MIDI.c\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the management of USB MIDI Class interfaces\r
- * within a USB device. Note that the MIDI class is actually a special case of the regular Audio class,\r
- * thus this module depends on structure definitions from the \ref Group_USBClassAudioDevice class driver module.\r
+ * Device Mode USB Class driver framework interface, for the MIDI USB Class driver.\r
*\r
* @{\r
*/\r
\r
-#ifndef _MIDI_CLASS_H_\r
-#define _MIDI_CLASS_H_\r
+#ifndef _MIDI_CLASS_DEVICE_H_\r
+#define _MIDI_CLASS_DEVICE_H_\r
\r
/* Includes: */\r
#include "../../USB.h"\r
+ #include "../Common/MIDI.h"\r
#include "Audio.h"\r
\r
#include <string.h>\r
extern "C" {\r
#endif\r
\r
- /* Macros: */\r
- /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */\r
- #define DSUBTYPE_InputJack 0x02\r
-\r
- /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */\r
- #define DSUBTYPE_OutputJack 0x03\r
- \r
- /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */\r
- #define MIDI_JACKTYPE_EMBEDDED 0x01\r
-\r
- /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */\r
- #define MIDI_JACKTYPE_EXTERNAL 0x02\r
-\r
- /** MIDI command for a note on (activation) event */\r
- #define MIDI_COMMAND_NOTE_ON 0x09\r
-\r
- /** MIDI command for a note off (deactivation) event */\r
- #define MIDI_COMMAND_NOTE_OFF 0x08\r
-\r
- /** Standard key press velocity value used for all note events, as no pressure sensor is mounted */\r
- #define MIDI_STANDARD_VELOCITY 64\r
- \r
- /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel\r
- * addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.\r
- *\r
- * \param channel MIDI channel number to address\r
- */\r
- #define MIDI_CHANNEL(channel) (channel - 1)\r
- \r
- /* Type Defines: */\r
- /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host\r
- * how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.\r
- * See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
- \r
- uint16_t AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */\r
- uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */\r
- } USB_AudioInterface_MIDI_AS_t;\r
- \r
- /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either\r
- * a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
- uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */\r
- uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Type Define: */\r
+ /** Class state structure. An instance of this structure should be made for each MIDI interface\r
+ * within the user application, and passed to each of the MIDI class driver functions as the\r
+ * MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.\r
+ */\r
+ typedef struct\r
+ {\r
+ const struct\r
+ {\r
+ uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */\r
+\r
+ uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI data, if available (zero if unused) */\r
+ uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI data endpoint, if available (zero if unused) */\r
+ bool DataINEndpointDoubleBank; /** Indicates if the MIDI interface's IN data endpoint should use double banking */\r
+\r
+ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused) */\r
+ uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused) */\r
+ bool DataOUTEndpointDoubleBank; /** Indicates if the MIDI interface's IN data endpoint should use double banking */\r
+ } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+ * <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+ */ \r
+ struct\r
+ {\r
+ // No state information for this class yet\r
+ } State; /**< State data for the USB class interface within the device. All elements in this section\r
+ * are reset to their defaults when the interface is enumerated.\r
+ */\r
+ } USB_ClassInfo_MIDI_Device_t; \r
+ \r
+ /* Function Prototypes: */\r
+ /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given MIDI interface is selected.\r
+ *\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state\r
+ *\r
+ * \return Boolean true if the endpoints were successfully configured, false otherwise\r
+ */\r
+ bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
- uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
- } USB_MIDI_In_Jack_t;\r
-\r
- /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either\r
- * a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
- uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */\r
- uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */\r
- \r
- uint8_t NumberOfPins; /**< Number of output channels within the jack, either physical or logical */\r
- uint8_t SourceJackID[1]; /**< ID of each output pin's source data jack */\r
- uint8_t SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */\r
- \r
- uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
- } USB_MIDI_Out_Jack_t;\r
- \r
- /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information\r
- * on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio\r
- * class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
- uint8_t TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */\r
- uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */\r
- } USB_MIDI_Jack_Endpoint_t;\r
-\r
- typedef struct\r
- {\r
- unsigned char Command : 4;\r
- unsigned char CableNumber : 4;\r
- \r
- uint8_t Data1;\r
- uint8_t Data2;\r
- uint8_t Data3; \r
- } USB_MIDI_EventPacket_t;\r
-\r
- typedef struct\r
- {\r
- uint8_t StreamingInterfaceNumber;\r
-\r
- uint8_t DataINEndpointNumber;\r
- uint16_t DataINEndpointSize;\r
-\r
- uint8_t DataOUTEndpointNumber;\r
- uint16_t DataOUTEndpointSize;\r
-\r
- bool InterfaceEnabled;\r
- } USB_ClassInfo_MIDI_t;\r
- \r
- /* Function Prototypes: */\r
- bool USB_MIDI_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
- void USB_MIDI_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
- void USB_MIDI_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
-\r
- void USB_MIDI_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
- bool USB_MIDI_ReceiveEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
+ /** Processes incoming control requests from the host, that are directed to the given MIDI class interface. This should be\r
+ * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
+ *\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state\r
+ */ \r
+ void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+ /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. Events are queued into the\r
+ * endpoint bank until either the endpoint bank is full, or \ref MIDI_Device_Flush() is called. This allows for multiple\r
+ * MIDI events to be packed into a single endpoint packet, increasing data throughput.\r
+ *\r
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state\r
+ * \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum \r
+ */\r
+ uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,\r
+ MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+\r
+\r
+ /** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the\r
+ * \ref MIDI_Device_SendEventPacket() function's packing behaviour, to flush queued events.\r
+ *\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state\r
+ *\r
+ * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r
+ */\r
+ uint8_t MIDI_Device_Flush(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo);\r
+\r
+ /** Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains\r
+ * multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event.\r
+ *\r
+ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or\r
+ * the call will fail.\r
+ *\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state\r
+ * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
+ *\r
+ * \return Boolean true if a MIDI event packet was received, false otherwise\r
+ */\r
+ bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,\r
+ MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+\r
+ /* Inline Functions: */\r
+ /** General management task for a given MIDI class interface, required for the correct operation of the interface. This should\r
+ * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+ *\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state\r
+ */\r
+ static inline void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo);\r
+ static inline void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo)\r
+ {\r
+ (void)MIDIInterfaceInfo;\r
+ } \r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
projects / pub / USBasp.git / blobdiff