Demos/Device/KeyboardMouse/KeyboardMouse.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)
  12
  13   Permission to use, copy, modify, and distribute this software
  14   and its documentation for any purpose and without fee is hereby
  15   granted, provided that the above copyright notice appear in all
  16   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>                    // Library Version Information
  45                 #include <LUFA/Drivers/USB/USB.h>            // USB Functionality
  46                 #include <LUFA/Drivers/Board/Joystick.h>     // Joystick driver
  47                 #include <LUFA/Drivers/Board/LEDs.h>         // LEDs driver
  48                 #include <LUFA/Drivers/Board/Buttons.h>      // Board Buttons driver
  49                 #include <LUFA/Scheduler/Scheduler.h>        // Simple scheduler for task management
  50
  51         /* Task Definitions: */
  52                 TASK(USB_Keyboard);
  53                 TASK(USB_Mouse);
  54
  55         /* Enums: */
  56                 /** Enum for the possible status codes for passing to the UpdateStatus() function. */
  57                 enum KeyboardMouse_StatusCodes_t
  58                 {
  59                         Status_USBNotReady    = 0, /**< USB is not ready (disconnected from a USB host) */
  60                         Status_USBEnumerating = 1, /**< USB interface is enumerating */
  61                         Status_USBReady       = 2, /**< USB interface is connected and ready */
  62                 };
  63
  64         /* Macros: */
  65                 /** HID Class specific request to get the next HID report from the device. */
  66                 #define REQ_GetReport      0x01
  67
  68                 /** HID Class specific request to send the next HID report to the device. */
  69                 #define REQ_SetReport      0x09
  70
  71                 /** HID Class specific request to get the current HID protocol in use, either report or boot. */
  72                 #define REQ_GetProtocol    0x03
  73
  74                 /** HID Class specific request to set the current HID protocol in use, either report or boot. */
  75                 #define REQ_SetProtocol    0x0B
  76
  77         /* Type Defines: */
  78                 /** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.
  79                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
  80                  */
  81                 typedef struct
  82                 {
  83                         uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */
  84                         uint8_t Reserved; /**< Reserved, always set as 0x00 */
  85                         uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */
  86                 } USB_KeyboardReport_Data_t;
  87
  88                 /** Type define for the mouse HID report structure, for creating and sending HID reports to the host PC.
  89                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
  90                  */
  91                 typedef struct
  92                 {
  93                         uint8_t Button; /**< Bit mask of the currently pressed mouse buttons */
  94                         int8_t  X; /**< Current mouse delta X movement, as a signed 8-bit integer */
  95                         int8_t  Y; /**< Current mouse delta Y movement, as a signed 8-bit integer */
  96                 } USB_MouseReport_Data_t;
  97
  98         /* Function Prototypes: */
  99                 void EVENT_USB_Connect(void);
 100                 void EVENT_USB_Disconnect(void);
 101                 void EVENT_USB_ConfigurationChanged(void);
 102                 void EVENT_USB_UnhandledControlPacket(void);
 103
 104                 void UpdateStatus(uint8_t CurrentStatus);
 105
 106 #endif