Demos/Device/LowLevel/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>
  51                 #include <LUFA/Drivers/USB/USB.h>
  52                 #include <LUFA/Drivers/Board/Joystick.h>
  53                 #include <LUFA/Drivers/Board/LEDs.h>
  54
  55         /* Macros: */
  56                 /** Idle period indicating that reports should be sent only when the inputs have changed */
  57                 #define HID_IDLE_CHANGESONLY   0
  58
  59                 /** HID Class specific request to get the next HID report from the device. */
  60                 #define REQ_GetReport          0x01
  61
  62                 /** HID Class specific request to get the idle timeout period of the device. */
  63                 #define REQ_GetIdle            0x02
  64
  65                 /** HID Class specific request to send the next HID report to the device. */
  66                 #define REQ_SetReport          0x09
  67
  68                 /** HID Class specific request to set the idle timeout period of the device. */
  69                 #define REQ_SetIdle            0x0A
  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                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  78                 #define LEDMASK_USB_NOTREADY      LEDS_LED1
  79
  80                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  81                 #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
  82
  83                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  84                 #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
  85
  86                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  87                 #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
  88
  89         /* Type Defines: */
  90                 /** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.
  91                  *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
  92                  */
  93                 typedef struct
  94                 {
  95                         uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */
  96                         uint8_t Reserved; /**< Reserved, always set as 0x00 */
  97                         uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */
  98                 } USB_KeyboardReport_Data_t;
  99
 100         /* Function Prototypes: */
 101                 void SetupHardware(void);
 102                 void HID_Task(void);
 103
 104                 void EVENT_USB_Device_Connect(void);
 105                 void EVENT_USB_Device_Disconnect(void);
 106                 void EVENT_USB_Device_ConfigurationChanged(void);
 107                 void EVENT_USB_Device_UnhandledControlRequest(void);
 108
 109                 void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);
 110                 void ProcessLEDReport(uint8_t LEDReport);
 111                 void SendNextReport(void);
 112                 void ReceiveNextReport(void);
 113
 114 #endif