Add Doxygen documentation to the completed portions of the PDI programming protocol...

[pub/USBasp.git] / Demos / Host / ClassDriver / MouseHost / MouseHost.h

diff --git a/Demos/Host/ClassDriver/MouseHost/MouseHost.h b/Demos/Host/ClassDriver/MouseHost/MouseHost.h
index 7111218..c6b2974 100644 (file)
--- a/Demos/Host/ClassDriver/MouseHost/MouseHost.h
+++ b/Demos/Host/ClassDriver/MouseHost/MouseHost.h
@@ -40,57 +40,36 @@
                #include <avr/io.h>\r
                #include <avr/wdt.h>\r
                #include <avr/pgmspace.h>\r
                #include <avr/io.h>\r
                #include <avr/wdt.h>\r
                #include <avr/pgmspace.h>\r

-               #include <avr/interrupt.h>\r

                #include <avr/power.h>\r
                #include <stdio.h>\r
 \r
                #include <avr/power.h>\r
                #include <stdio.h>\r
 \r

-               #include <LUFA/Version.h>                                // Library Version Information\r
-               #include <LUFA/Drivers/Misc/TerminalCodes.h>             // ANSI Terminal Escape Codes\r
-               #include <LUFA/Drivers/USB/USB.h>                        // USB Functionality\r
-               #include <LUFA/Drivers/Peripheral/SerialStream.h>        // Serial stream driver\r
-               #include <LUFA/Drivers/Board/LEDs.h>                     // LEDs driver\r
-               #include <LUFA/Scheduler/Scheduler.h>                    // Simple scheduler for task management\r
-               \r
-               #include "ConfigDescriptor.h"\r
+               #include <LUFA/Version.h>\r
+               #include <LUFA/Drivers/Misc/TerminalCodes.h>\r
+               #include <LUFA/Drivers/Peripheral/SerialStream.h>\r
+               #include <LUFA/Drivers/Board/LEDs.h>\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+               #include <LUFA/Drivers/USB/Class/HID.h>\r

                \r
        /* Macros: */\r
                \r
        /* Macros: */\r

-               /** Pipe number for the mouse data IN pipe */\r
-               #define MOUSE_DATAPIPE              1\r
-               \r
-               /** HID Class Specific request to set the report protocol mode */\r
-               #define REQ_SetProtocol             0x0B\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

-       /* Type Defines: */\r
-               /** Type define for a standard Boot Protocol Mouse report */\r
-               typedef struct\r
-               {\r
-                       uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */\r
-                       int8_t  X; /**< Current delta X movement of the mouse */\r
-                       int8_t  Y; /**< Current delta Y movement on the mouse */\r
-               } USB_MouseReport_Data_t;\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

-       /* Task Definitions: */\r
-               TASK(USB_Mouse_Host);\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
 \r

-       /* Enums: */\r
-               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
-               enum MouseHost_StatusCodes_t\r
-               {\r
-                       Status_USBNotReady      = 0, /**< USB is not ready (disconnected from a USB device) */\r
-                       Status_USBEnumerating   = 1, /**< USB interface is enumerating */\r
-                       Status_USBReady         = 2, /**< USB interface is connected and ready */\r
-                       Status_EnumerationError = 3, /**< Software error while enumerating the attached USB device */\r
-                       Status_HardwareError    = 4, /**< Hardware error while enumerating the attached USB device */\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
        /* Function Prototypes: */\r
                \r
        /* Function Prototypes: */\r

-               void EVENT_USB_HostError(const uint8_t ErrorCode);\r
-               void EVENT_USB_DeviceAttached(void);\r
-               void EVENT_USB_DeviceUnattached(void);\r
-               void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
-               void EVENT_USB_DeviceEnumerationComplete(void);\r
-\r
-               void UpdateStatus(uint8_t CurrentStatus);\r
-               void ReadNextReport(void);\r
+               void SetupHardware(void);\r
+       \r
+               void EVENT_USB_Host_HostError(const uint8_t ErrorCode);\r
+               void EVENT_USB_Host_DeviceAttached(void);\r
+               void EVENT_USB_Host_DeviceUnattached(void);\r
+               void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);\r
+               void EVENT_USB_Host_DeviceEnumerationComplete(void);\r

                \r
 #endif\r
                \r
 #endif\r