Demos/Device/LowLevel/Keyboard/Keyboard.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 /** \file
  33  *
  34  *  Header file for Keyboard.c.
  35  */
  36
  37 #ifndef _KEYBOARD_H_
  38 #define _KEYBOARD_H_
  39
  40         /* Includes: */
  41                 #include <avr/io.h>
  42                 #include <avr/wdt.h>
  43                 #include <avr/power.h>
  44                 #include <avr/interrupt.h>
  45                 #include <stdbool.h>
  46                 #include <string.h>
  47
  48                 #include "Descriptors.h"
  49
  50                 #include <LUFA/Version.h>
  51                 #include <LUFA/Drivers/USB/USB.h>
  52                 #include <LUFA/Drivers/Board/Joystick.h>
  53                 #include <LUFA/Drivers/Board/Buttons.h>
  54                 #include <LUFA/Drivers/Board/LEDs.h>
  55
  56         /* Macros: */
  57                 /** Idle period indicating that reports should be sent only when the inputs have changed. */
  58                 #define HID_IDLE_CHANGESONLY        0
  59
  60                 /** HID Class specific request to get the next HID report from the device. */
  61                 #define REQ_GetReport               0x01
  62
  63                 /** HID Class specific request to get the idle timeout period of the device. */
  64                 #define REQ_GetIdle                 0x02
  65
  66                 /** HID Class specific request to send the next HID report to the device. */
  67                 #define REQ_SetReport               0x09
  68
  69                 /** HID Class specific request to set the idle timeout period of the device. */
  70                 #define REQ_SetIdle                 0x0A
  71
  72                 /** HID Class specific request to get the current HID protocol in use, either report or boot. */
  73                 #define REQ_GetProtocol             0x03
  74
  75                 /** HID Class specific request to set the current HID protocol in use, either report or boot. */
  76                 #define REQ_SetProtocol             0x0B
  77
  78                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */
  79                 #define KEYBOARD_MODIFER_LEFTCTRL   (1 << 0)
  80
  81                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed. */
  82                 #define KEYBOARD_MODIFER_LEFTSHIFT  (1 << 1)
  83
  84                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed. */
  85                 #define KEYBOARD_MODIFER_LEFTALT    (1 << 2)
  86
  87                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed. */
  88                 #define KEYBOARD_MODIFER_LEFTGUI    (1 << 3)
  89
  90                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed. */
  91                 #define KEYBOARD_MODIFER_RIGHTCTRL  (1 << 4)
  92
  93                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed. */
  94                 #define KEYBOARD_MODIFER_RIGHTSHIFT (1 << 5)
  95
  96                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed. */
  97                 #define KEYBOARD_MODIFER_RIGHTALT   (1 << 6)
  98
  99                 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */
 100                 #define KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)
 101
 102                 /** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */
 103                 #define KEYBOARD_LED_NUMLOCK        (1 << 0)
 104
 105                 /** Constant for a keyboard output report LED byte, indicating that the host's CAPS LOCK mode is currently set. */
 106                 #define KEYBOARD_LED_CAPSLOCK       (1 << 1)
 107
 108                 /** Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set. */
 109                 #define KEYBOARD_LED_SCROLLLOCK     (1 << 2)
 110
 111                 /** Constant for a keyboard output report LED byte, indicating that the host's KATANA mode is currently set. */
 112                 #define KEYBOARD_LED_KATANA         (1 << 3)
 113
 114                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
 115                 #define LEDMASK_USB_NOTREADY        LEDS_LED1
 116
 117                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
 118                 #define LEDMASK_USB_ENUMERATING     (LEDS_LED2 | LEDS_LED3)
 119
 120                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
 121                 #define LEDMASK_USB_READY           (LEDS_LED2 | LEDS_LED4)
 122
 123                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
 124                 #define LEDMASK_USB_ERROR           (LEDS_LED1 | LEDS_LED3)
 125
 126         /* Type Defines: */
 127                 /** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.
 128                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
 129                  */
 130                 typedef struct
 131                 {
 132                         uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */
 133                         uint8_t Reserved; /**< Reserved, always set as 0x00 */
 134                         uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */
 135                 } USB_KeyboardReport_Data_t;
 136
 137         /* Function Prototypes: */
 138                 void SetupHardware(void);
 139                 void HID_Task(void);
 140
 141                 void EVENT_USB_Device_Connect(void);
 142                 void EVENT_USB_Device_Disconnect(void);
 143                 void EVENT_USB_Device_ConfigurationChanged(void);
 144                 void EVENT_USB_Device_UnhandledControlRequest(void);
 145                 void EVENT_USB_Device_StartOfFrame(void);
 146
 147                 void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);
 148                 void ProcessLEDReport(uint8_t LEDReport);
 149                 void SendNextReport(void);
 150                 void ReceiveNextReport(void);
 151
 152 #endif