Oops - fix include directory for case-sensitive filesystems.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / MIDI.h

diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h
index 0963aab..2b6ec5b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/MIDI.h
+++ b/LUFA/Drivers/USB/Class/Device/MIDI.h
@@ -9,13 +9,13 @@
 /*\r
   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -31,6 +31,10 @@
 /** \ingroup Group_USBClassMIDI\r
  *  @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver\r
  *\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
  *  Device Mode USB Class driver framework interface, for the MIDI USB Class driver.\r
  *\r
  *  \section Module Description\r
  *  Device Mode USB Class driver framework interface, for the MIDI USB Class driver.\r
  *\r


@@ -52,46 +56,80 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\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_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
-                *  containing the given MIDI interface is selected.\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                *\r
-                *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
-                */\r
-               bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
-               \r
-               /** Processes incomming 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_UnhandledControlPacket() event.\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                */             \r
-               void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
-\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 MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                */\r
-               void MIDI_Device_USBTask(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo);\r
-\r
-               /** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                *  \param Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
-                */\r
-               void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\r
-\r
-               /** Receives a MIDI event packet from the host.\r
-                *\r
-                *  \param MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state.\r
-                *  \param 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_t* MIDIInterfaceInfo, USB_MIDI_EventPacket_t* Event);\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
+                       /** 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
+                       /** 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
+                       void MIDI_Device_USBTask(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.\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
+                       /** Receives a MIDI event packet from the host.\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
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r