Standardized the naming scheme given to configuration descriptor sub-elements in...

[pub/USBasp.git] / Demos / Device / LowLevel / Joystick / Joystick.h

diff --git a/Demos/Device/LowLevel/Joystick/Joystick.h b/Demos/Device/LowLevel/Joystick/Joystick.h
index 9763cad..811cb4e 100644 (file)
--- a/Demos/Device/LowLevel/Joystick/Joystick.h
+++ b/Demos/Device/LowLevel/Joystick/Joystick.h
@@ -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
-\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
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -44,20 +44,28 @@
 \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
-               \r
-       /* Task Definitions: */\r
-               TASK(USB_Joystick_Report);\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
                /** HID Class specific request to get the next HID report from the device. */\r
 \r
        /* Macros: */\r
                /** HID Class specific request to get the next HID report from the device. */\r

-               #define REQ_GetReport   0x01\r
+               #define REQ_GetReport             0x01\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
+               /** 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

+               /** 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

        /* Type Defines: */\r
                /** Type define for the joystick HID report structure, for creating and sending HID reports to the host PC.\r
                 *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.\r
        /* Type Defines: */\r
                /** Type define for the joystick HID report structure, for creating and sending HID reports to the host PC.\r
                 *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.\r


@@ -68,23 +76,16 @@
                        int8_t  Y; /**< Current absolute joystick Y position, as a signed 8-bit integer */\r
                        uint8_t Button; /**< Bit mask of the currently pressed joystick buttons */\r
                } USB_JoystickReport_Data_t;\r
                        int8_t  Y; /**< Current absolute joystick Y position, as a signed 8-bit integer */\r
                        uint8_t Button; /**< Bit mask of the currently pressed joystick buttons */\r
                } USB_JoystickReport_Data_t;\r

-                       \r
-       /* Enums: */\r
-               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
-               enum Joystick_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

 \r
        /* Function Prototypes: */\r
 \r
        /* Function Prototypes: */\r

-               void EVENT_USB_Connect(void);\r
-               void EVENT_USB_Disconnect(void);\r
-               void EVENT_USB_ConfigurationChanged(void);\r
-               void EVENT_USB_UnhandledControlPacket(void);\r
+               void SetupHardware(void);\r
+               void HID_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
+               void EVENT_USB_Device_UnhandledControlRequest(void);\r

 \r
                bool GetNextReport(USB_JoystickReport_Data_t* ReportData);\r
 \r
                bool GetNextReport(USB_JoystickReport_Data_t* ReportData);\r

-               void UpdateStatus(uint8_t CurrentStatus);\r

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