Add FatFS library to the Webserver project, extend the HTTP server so that it now...
[pub/USBasp.git] / Demos / Device / LowLevel / MIDI / MIDI.h
index 635036a..82e42da 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\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
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \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
 \r
                #include "Descriptors.h"\r
                                \r
 \r
                #include "Descriptors.h"\r
                                \r
-               #include <LUFA/Version.h>                            // Library Version Information\r
-               #include <LUFA/Drivers/USB/USB.h>                    // USB Functionality\r
-               #include <LUFA/Drivers/Board/Joystick.h>             // Joystick driver\r
-               #include <LUFA/Drivers/Board/LEDs.h>                 // LEDs driver\r
-               #include <LUFA/Drivers/Board/Buttons.h>              // Board Buttons driver\r
-               #include <LUFA/Scheduler/Scheduler.h>                // Simple scheduler for task management\r
+               #include <LUFA/Version.h>\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+               #include <LUFA/Drivers/Board/Joystick.h>\r
+               #include <LUFA/Drivers/Board/LEDs.h>\r
+               #include <LUFA/Drivers/Board/Buttons.h>\r
 \r
    /* Macros: */\r
                /** MIDI command for a note on (activation) event */\r
 \r
    /* Macros: */\r
                /** MIDI command for a note on (activation) event */\r
-               #define MIDI_COMMAND_NOTE_ON         0x90\r
+               #define MIDI_COMMAND_NOTE_ON      0x90\r
 \r
                /** MIDI command for a note off (deactivation) event */\r
 \r
                /** MIDI command for a note off (deactivation) event */\r
-               #define MIDI_COMMAND_NOTE_OFF        0x80\r
+               #define MIDI_COMMAND_NOTE_OFF     0x80\r
 \r
                /** Standard key press velocity value used for all note events, as no pressure sensor is mounted */\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
+               #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
                \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
+                *  \param[in] channel  MIDI channel number to address\r
                 */\r
                 */\r
-               #define MIDI_CHANNEL(channel)        (channel - 1)\r
+               #define MIDI_CHANNEL(channel)    ((channel) - 1)\r
 \r
 \r
-       /* Enums: */\r
-               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
-               enum MIDI_StatusCodes_t\r
-               {\r
-                       Status_USBNotReady    = 0, /**< USB is not ready (disconnected from a USB host) */\r
-                       Status_USBEnumerating = 1, /**< USB interface is enumerating */\r
-                       Status_USBReady       = 2, /**< USB interface is connected and ready */\r
-               };\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */\r
+               #define LEDMASK_USB_NOTREADY      LEDS_LED1\r
 \r
 \r
-       /* Task Definitions: */\r
-               TASK(USB_MIDI_Task);\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */\r
+               #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)\r
 \r
 \r
-   /* Function Prototypes: */\r
-               void EVENT_USB_Connect(void);\r
-               void EVENT_USB_Disconnect(void);\r
-               void EVENT_USB_ConfigurationChanged(void);\r
+               /** LED mask for the library LED driver, to indicate that the USB interface is ready. */\r
+               #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)\r
+\r
+               /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */\r
+               #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)\r
 \r
 \r
-               void SendMIDINoteChange(const uint8_t Pitch, const bool OnOff,\r
-                                       const uint8_t CableID, const uint8_t Channel);          \r
-               void UpdateStatus(uint8_t CurrentStatus);\r
+       /* Type Defines: */\r
+               /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */\r
+               typedef struct\r
+               {\r
+                       unsigned char Command     : 4; /**< MIDI command being sent or received in the event packet */\r
+                       unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */\r
+                       \r
+                       uint8_t Data1; /**< First byte of data in the MIDI event */\r
+                       uint8_t Data2; /**< Second byte of data in the MIDI event */\r
+                       uint8_t Data3; /**< Third byte of data in the MIDI event */             \r
+               } USB_MIDI_EventPacket_t;\r
+               \r
+   /* Function Prototypes: */\r
+               void SetupHardware(void);\r
+               void MIDI_Task(void);\r
+   \r
+               void EVENT_USB_Device_Connect(void);\r
+               void EVENT_USB_Device_Disconnect(void);\r
+               void EVENT_USB_Device_ConfigurationChanged(void);\r
                \r
 #endif\r
                \r
 #endif\r