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                 /** 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         /* Task Definitions: */
  79                 TASK(USB_Keyboard_Report);
  80
  81         /* Type Defines: */
  82                 /** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.
  83                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
  84                  */
  85                 typedef struct
  86                 {
  87                         uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */
  88                         uint8_t Reserved; /**< Reserved, always set as 0x00 */
  89                         uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */
  90                 } USB_KeyboardReport_Data_t;
  91
  92         /* Enums: */
  93                 /** Enum for the possible status codes for passing to the UpdateStatus() function. */
  94                 enum Keyboard_StatusCodes_t
  95                 {
  96                         Status_USBNotReady    = 0, /**< USB is not ready (disconnected from a USB host) */
  97                         Status_USBEnumerating = 1, /**< USB interface is enumerating */
  98                         Status_USBReady       = 2, /**< USB interface is connected and ready */
  99                 };
 100
 101         /* Function Prototypes: */
 102                 void EVENT_USB_Connect(void);
 103                 void EVENT_USB_Disconnect(void);
 104                 void EVENT_USB_ConfigurationChanged(void);
 105                 void EVENT_USB_UnhandledControlPacket(void);
 106
 107                 void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);
 108                 void ProcessLEDReport(uint8_t LEDReport);
 109                 void SendNextReport(void);
 110                 void ReceiveNextReport(void);
 111                 void UpdateStatus(uint8_t CurrentStatus);
 112
 113 #endif