Demos/Device/ClassDriver/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  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, 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/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/Board/Joystick.h>
  52                 #include <LUFA/Drivers/Board/LEDs.h>
  53                 #include <LUFA/Drivers/Board/Buttons.h>
  54                 #include <LUFA/Drivers/USB/USB.h>
  55                 #include <LUFA/Drivers/USB/Class/HID.h>
  56
  57         /* Macros: */
  58                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  59                 #define LEDMASK_USB_NOTREADY      LEDS_LED1
  60
  61                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  62                 #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
  63
  64                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  65                 #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
  66
  67                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  68                 #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
  69
  70         /* Function Prototypes: */
  71                 void SetupHardware(void);
  72
  73                 void EVENT_USB_Device_Connect(void);
  74                 void EVENT_USB_Device_Disconnect(void);
  75                 void EVENT_USB_Device_ConfigurationChanged(void);
  76                 void EVENT_USB_Device_UnhandledControlRequest(void);
  77                 void EVENT_USB_Device_StartOfFrame(void);
  78
  79                 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
  80                                                  const uint8_t ReportType, void* ReportData, uint16_t* ReportSize);
  81                 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
  82                                                           const void* ReportData, const uint16_t ReportSize);
  83
  84 #endif