Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Demos / Device / LowLevel / Keyboard / Keyboard.h
index cdce24d..4e6dde5 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\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
-      Based on code by 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, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Header file for Keyboard.c.\r
- */\r
-\r
-#ifndef _KEYBOARD_H_\r
-#define _KEYBOARD_H_\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <avr/wdt.h>\r
-               #include <avr/power.h>\r
-               #include <stdbool.h>\r
-               #include <string.h>\r
-\r
-               #include "Descriptors.h"\r
-\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
-               #define HID_IDLE_CHANGESONLY      0\r
-\r
-               /** HID Class specific request to get the next HID report from the device. */\r
-               #define REQ_GetReport             0x01\r
-\r
-               /** HID Class specific request to get the idle timeout period of the device. */\r
-               #define REQ_GetIdle               0x02\r
-\r
-               /** HID Class specific request to send the next HID report to the device. */\r
-               #define REQ_SetReport             0x09\r
-\r
-               /** HID Class specific request to set the idle timeout period of the device. */\r
-               #define REQ_SetIdle               0x0A\r
-\r
-               /** HID Class specific request to get the current HID protocol in use, either report or boot. */\r
-               #define REQ_GetProtocol           0x03\r
-\r
-               /** HID Class specific request to set the current HID protocol in use, either report or boot. */\r
-               #define REQ_SetProtocol           0x0B\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
-               /** 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
-                *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.\r
-                */\r
-               typedef struct\r
-               {\r
-                       uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */\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
-       /* Function Prototypes: */\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
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Header file for Keyboard.c.
+ */
+
+#ifndef _KEYBOARD_H_
+#define _KEYBOARD_H_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/wdt.h>
+               #include <avr/power.h>
+               #include <avr/interrupt.h>
+               #include <stdbool.h>
+               #include <string.h>
+
+               #include "Descriptors.h"
+
+               #include <LUFA/Version.h>
+               #include <LUFA/Drivers/USB/USB.h>
+               #include <LUFA/Drivers/Board/Joystick.h>
+               #include <LUFA/Drivers/Board/Buttons.h>
+               #include <LUFA/Drivers/Board/LEDs.h>
+
+       /* Macros: */
+               /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
+               #define LEDMASK_USB_NOTREADY        LEDS_LED1
+
+               /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
+               #define LEDMASK_USB_ENUMERATING     (LEDS_LED2 | LEDS_LED3)
+
+               /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
+               #define LEDMASK_USB_READY           (LEDS_LED2 | LEDS_LED4)
+
+               /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
+               #define LEDMASK_USB_ERROR           (LEDS_LED1 | LEDS_LED3)
+
+       /* Function Prototypes: */
+               void SetupHardware(void);
+               void HID_Task(void);
+
+               void EVENT_USB_Device_Connect(void);
+               void EVENT_USB_Device_Disconnect(void);
+               void EVENT_USB_Device_ConfigurationChanged(void);
+               void EVENT_USB_Device_ControlRequest(void);
+               void EVENT_USB_Device_StartOfFrame(void);
+
+               void CreateKeyboardReport(USB_KeyboardReport_Data_t* const ReportData);
+               void ProcessLEDReport(const uint8_t LEDReport);
+               void SendNextReport(void);
+               void ReceiveNextReport(void);
+
+#endif
+