Added incomplete MIDIToneGenerator project.
[pub/USBasp.git] / Demos / Device / LowLevel / Keyboard / Keyboard.h
index c4ed6e0..4cb3616 100644 (file)
@@ -1,22 +1,22 @@
 /*\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  Denver Gingerich (denver [at] ossguy [dot] com)\r
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)\r
       Based on code by Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
       Based on code by 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
        /* Includes: */\r
                #include <avr/io.h>\r
                #include <avr/wdt.h>\r
        /* Includes: */\r
                #include <avr/io.h>\r
                #include <avr/wdt.h>\r
-               #include <avr/interrupt.h>\r
                #include <avr/power.h>\r
                #include <stdbool.h>\r
                #include <string.h>\r
 \r
                #include "Descriptors.h"\r
 \r
                #include <avr/power.h>\r
                #include <stdbool.h>\r
                #include <string.h>\r
 \r
                #include "Descriptors.h"\r
 \r
-               #include <LUFA/Version.h>                    // Library Version Information\r
-               #include <LUFA/Scheduler/Scheduler.h>        // Simple scheduler for task management\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/Version.h>\r
+               #include <LUFA/Drivers/USB/USB.h>\r
+               #include <LUFA/Drivers/Board/Joystick.h>\r
+               #include <LUFA/Drivers/Board/Buttons.h>\r
+               #include <LUFA/Drivers/Board/LEDs.h>\r
 \r
        /* Macros: */\r
                /** Idle period indicating that reports should be sent only when the inputs have changed */\r
 \r
        /* Macros: */\r
                /** Idle period indicating that reports should be sent only when the inputs have changed */\r
-               #define HID_IDLE_CHANGESONLY   0\r
+               #define HID_IDLE_CHANGESONLY        0\r
 \r
                /** HID Class specific request to get the next HID report from the device. */\r
 \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
                /** HID Class specific request to get the idle timeout period of the device. */\r
 \r
                /** HID Class specific request to get the idle timeout period of the device. */\r
-               #define REQ_GetIdle            0x02\r
+               #define REQ_GetIdle                 0x02\r
 \r
                /** HID Class specific request to send the next HID report to the device. */\r
 \r
                /** HID Class specific request to send the next HID report to the device. */\r
-               #define REQ_SetReport          0x09\r
+               #define REQ_SetReport               0x09\r
 \r
                /** HID Class specific request to set the idle timeout period of the device. */\r
 \r
                /** HID Class specific request to set the idle timeout period of the device. */\r
-               #define REQ_SetIdle            0x0A\r
+               #define REQ_SetIdle                 0x0A\r
 \r
                /** HID Class specific request to get the current HID protocol in use, either report or boot. */\r
 \r
                /** HID Class specific request to get the current HID protocol in use, either report or boot. */\r
-               #define REQ_GetProtocol        0x03\r
+               #define REQ_GetProtocol             0x03\r
 \r
                /** HID Class specific request to set the current HID protocol in use, either report or boot. */\r
 \r
                /** HID Class specific request to set the current HID protocol in use, either report or boot. */\r
-               #define REQ_SetProtocol        0x0B\r
+               #define REQ_SetProtocol             0x0B\r
+\r
+               /** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */\r
+               #define KEYBOARD_MODIFER_LEFTCTRL   (1 << 0)\r
+\r
+               /** Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed. */\r
+               #define KEYBOARD_MODIFER_LEFTSHIFT  (1 << 1)\r
+\r
+               /** Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed. */\r
+               #define KEYBOARD_MODIFER_LEFTALT    (1 << 2)\r
+\r
+               /** Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed. */\r
+               #define KEYBOARD_MODIFER_LEFTGUI    (1 << 3)\r
+\r
+               /** Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed. */\r
+               #define KEYBOARD_MODIFER_RIGHTCTRL  (1 << 4)\r
+\r
+               /** Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed. */\r
+               #define KEYBOARD_MODIFER_RIGHTSHIFT (1 << 5)\r
+\r
+               /** Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed. */\r
+               #define KEYBOARD_MODIFER_RIGHTALT   (1 << 6)\r
+\r
+               /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */\r
+               #define KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)\r
+\r
+               /** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */\r
+               #define KEYBOARD_LED_NUMLOCK        (1 << 0)\r
+               \r
+               /** Constant for a keyboard output report LED byte, indicating that the host's CAPS LOCK mode is currently set. */\r
+               #define KEYBOARD_LED_CAPSLOCK       (1 << 1)\r
+\r
+               /** Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set. */\r
+               #define KEYBOARD_LED_SCROLLLOCK     (1 << 2)\r
+\r
+               /** Constant for a keyboard output report LED byte, indicating that the host's KATANA mode is currently set. */\r
+               #define KEYBOARD_LED_KATANA         (1 << 3)\r
                \r
                \r
-       /* Task Definitions: */\r
-               TASK(USB_Keyboard_Report);\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
+               /** 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 keyboard HID report structure, for creating and sending HID reports to the host PC.\r
 \r
        /* Type Defines: */\r
                /** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.\r
                        uint8_t Reserved; /**< Reserved, always set as 0x00 */\r
                        uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */\r
                } USB_KeyboardReport_Data_t;\r
                        uint8_t Reserved; /**< Reserved, always set as 0x00 */\r
                        uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */\r
                } USB_KeyboardReport_Data_t;\r
-                       \r
-       /* Enums: */\r
-               /** Enum for the possible status codes for passing to the UpdateStatus() function. */\r
-               enum Keyboard_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
+               void EVENT_USB_Device_StartOfFrame(void);\r
 \r
                void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);\r
                void ProcessLEDReport(uint8_t LEDReport);\r
                void SendNextReport(void);\r
                void ReceiveNextReport(void);\r
 \r
                void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);\r
                void ProcessLEDReport(uint8_t LEDReport);\r
                void SendNextReport(void);\r
                void ReceiveNextReport(void);\r
-               void UpdateStatus(uint8_t CurrentStatus);\r
 \r
 #endif\r
 \r
 #endif\r