Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
  12
  13   Permission to use, copy, modify, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaim all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 #ifndef _KEYBOARD_MOUSE_H_
  33 #define _KEYBOARD_MOUSE_H_
  34
  35         /* Includes: */
  36                 #include <avr/io.h>
  37                 #include <avr/wdt.h>
  38                 #include <avr/power.h>
  39                 #include <stdbool.h>
  40                 #include <string.h>
  41
  42                 #include "Descriptors.h"
  43
  44                 #include <LUFA/Version.h>
  45                 #include <LUFA/Drivers/USB/USB.h>
  46                 #include <LUFA/Drivers/Board/Joystick.h>
  47                 #include <LUFA/Drivers/Board/LEDs.h>
  48                 #include <LUFA/Drivers/Board/Buttons.h>
  49
  50         /* Macros: */
  51                 /** HID Class specific request to get the next HID report from the device. */
  52                 #define REQ_GetReport               0x01
  53
  54                 /** HID Class specific request to send the next HID report to the device. */
  55                 #define REQ_SetReport               0x09
  56
  57                 /** HID Class specific request to get the current HID protocol in use, either report or boot. */
  58                 #define REQ_GetProtocol             0x03
  59
  60                 /** HID Class specific request to set the current HID protocol in use, either report or boot. */
  61                 #define REQ_SetProtocol             0x0B
  62
  63                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */
  64                 #define KEYBOARD_MODIFER_LEFTCTRL   (1 << 0)
  65
  66                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed. */
  67                 #define KEYBOARD_MODIFER_LEFTSHIFT  (1 << 1)
  68
  69                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed. */
  70                 #define KEYBOARD_MODIFER_LEFTALT    (1 << 2)
  71
  72                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed. */
  73                 #define KEYBOARD_MODIFER_LEFTGUI    (1 << 3)
  74
  75                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed. */
  76                 #define KEYBOARD_MODIFER_RIGHTCTRL  (1 << 4)
  77
  78                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed. */
  79                 #define KEYBOARD_MODIFER_RIGHTSHIFT (1 << 5)
  80
  81                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed. */
  82                 #define KEYBOARD_MODIFER_RIGHTALT   (1 << 6)
  83
  84                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */
  85                 #define KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)
  86
  87                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  88                 #define LEDMASK_USB_NOTREADY        LEDS_LED1
  89
  90                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  91                 #define LEDMASK_USB_ENUMERATING     (LEDS_LED2 | LEDS_LED3)
  92
  93                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  94                 #define LEDMASK_USB_READY           (LEDS_LED2 | LEDS_LED4)
  95
  96                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  97                 #define LEDMASK_USB_ERROR           (LEDS_LED1 | LEDS_LED3)
  98
  99         /* Type Defines: */
 100                 /** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.
 101                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
 102                  */
 103                 typedef struct
 104                 {
 105                         uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */
 106                         uint8_t Reserved; /**< Reserved, always set as 0x00 */
 107                         uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */
 108                 } USB_KeyboardReport_Data_t;
 109
 110                 /** Type define for the mouse HID report structure, for creating and sending HID reports to the host PC.
 111                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
 112                  */
 113                 typedef struct
 114                 {
 115                         uint8_t Button; /**< Bit mask of the currently pressed mouse buttons */
 116                         int8_t  X; /**< Current mouse delta X movement, as a signed 8-bit integer */
 117                         int8_t  Y; /**< Current mouse delta Y movement, as a signed 8-bit integer */
 118                 } USB_MouseReport_Data_t;
 119
 120         /* Function Prototypes: */
 121                 void SetupHardware(void);
 122                 void Keyboard_HID_Task(void);
 123                 void Mouse_HID_Task(void);
 124
 125                 void EVENT_USB_Device_Connect(void);
 126                 void EVENT_USB_Device_Disconnect(void);
 127                 void EVENT_USB_Device_ConfigurationChanged(void);
 128                 void EVENT_USB_Device_UnhandledControlRequest(void);
 129                 void EVENT_USB_Device_StartOfFrame(void);
 130
 131 #endif