Demos/Device/Keyboard/Keyboard.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  Denver Gingerich (denver [at] ossguy [dot] com)
  11       Based on code by Dean Camera (dean [at] fourwalledcubicle [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 /** \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/interrupt.h>
  44                 #include <avr/power.h>
  45                 #include <stdbool.h>
  46                 #include <string.h>
  47
  48                 #include "Descriptors.h"
  49
  50                 #include <LUFA/Version.h>                    // Library Version Information
  51                 #include <LUFA/Scheduler/Scheduler.h>        // Simple scheduler for task management
  52                 #include <LUFA/Drivers/USB/USB.h>            // USB Functionality
  53                 #include <LUFA/Drivers/Board/Joystick.h>     // Joystick driver
  54                 #include <LUFA/Drivers/Board/LEDs.h>         // LEDs driver
  55
  56         /* Macros: */
  57                 /** HID Class specific request to get the next HID report from the device. */
  58                 #define REQ_GetReport      0x01
  59
  60                 /** HID Class specific request to get the idle timeout period of the device. */
  61                 #define REQ_GetIdle        0x02
  62
  63                 /** HID Class specific request to send the next HID report to the device. */
  64                 #define REQ_SetReport      0x09
  65
  66                 /** HID Class specific request to set the idle timeout period of the device. */
  67                 #define REQ_SetIdle        0x0A
  68
  69                 /** HID Class specific request to get the current HID protocol in use, either report or boot. */
  70                 #define REQ_GetProtocol    0x03
  71
  72                 /** HID Class specific request to set the current HID protocol in use, either report or boot. */
  73                 #define REQ_SetProtocol    0x0B
  74
  75         /* Task Definitions: */
  76                 TASK(USB_Keyboard_Report);
  77
  78         /* Type Defines: */
  79                 /** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.
  80                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
  81                  */
  82                 typedef struct
  83                 {
  84                         uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */
  85                         uint8_t Reserved; /**< Reserved, always set as 0x00 */
  86                         uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */
  87                 } USB_KeyboardReport_Data_t;
  88
  89         /* Enums: */
  90                 /** Enum for the possible status codes for passing to the UpdateStatus() function. */
  91                 enum Keyboard_StatusCodes_t
  92                 {
  93                         Status_USBNotReady    = 0, /**< USB is not ready (disconnected from a USB host) */
  94                         Status_USBEnumerating = 1, /**< USB interface is enumerating */
  95                         Status_USBReady       = 2, /**< USB interface is connected and ready */
  96                 };
  97
  98         /* Event Handlers: */
  99                 /** Indicates that this module will catch the USB_Connect event when thrown by the library. */
 100                 HANDLES_EVENT(USB_Connect);
 101
 102                 /** Indicates that this module will catch the USB_Disconnect event when thrown by the library. */
 103                 HANDLES_EVENT(USB_Disconnect);
 104
 105                 /** Indicates that this module will catch the USB_Reset event when thrown by the library. */
 106                 HANDLES_EVENT(USB_Reset);
 107
 108                 /** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */
 109                 HANDLES_EVENT(USB_ConfigurationChanged);
 110
 111                 /** Indicates that this module will catch the USB_UnhandledControlPacket event when thrown by the library. */
 112                 HANDLES_EVENT(USB_UnhandledControlPacket);
 113
 114         /* Function Prototypes: */
 115                 void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);
 116                 void ProcessLEDReport(uint8_t LEDReport);
 117                 static inline void SendNextReport(void);
 118                 static inline void ReceiveNextReport(void);
 119                 void UpdateStatus(uint8_t CurrentStatus);
 120
 121 #endif