Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.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  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for KeyboardHost.c.
  34  */
  35
  36 #ifndef _KEYBOARD_HOST_H_
  37 #define _KEYBOARD_HOST_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/pgmspace.h>
  43                 #include <avr/power.h>
  44                 #include <avr/interrupt.h>
  45                 #include <stdio.h>
  46
  47                 #include <LUFA/Version.h>                                // Library Version Information
  48                 #include <LUFA/Drivers/Misc/TerminalCodes.h>             // ANSI Terminal Escape Codes
  49                 #include <LUFA/Drivers/USB/USB.h>                        // USB Functionality
  50                 #include <LUFA/Drivers/Peripheral/SerialStream.h>        // Serial stream driver
  51                 #include <LUFA/Drivers/Board/LEDs.h>                     // LEDs driver
  52                 #include <LUFA/Scheduler/Scheduler.h>                    // Simple scheduler for task management
  53
  54                 #include "ConfigDescriptor.h"
  55
  56         /* Macros: */
  57                 /** Pipe number for the keyboard data IN pipe */
  58                 #define KEYBOARD_DATAPIPE           1
  59
  60                 /** HID Class Specific request to set the report protocol mode */
  61                 #define REQ_SetProtocol             0x0B
  62
  63         /* Type Defines: */
  64                 /** Type define for a standard Boot Protocol Keyboard report */
  65                 typedef struct
  66                 {
  67                         uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (such as Shift, Control, etc.) */
  68                         uint8_t RESERVED; /**< Reserved for OEM use, always set to 0 */
  69                         uint8_t KeyCode; /**< Key code of the currently pressed key */
  70                 } USB_KeyboardReport_Data_t;
  71
  72         /* Enums: */
  73                 /** Enum for the possible status codes for passing to the UpdateStatus() function. */
  74                 enum KeyboardHost_StatusCodes_t
  75                 {
  76                         Status_USBNotReady      = 0, /**< USB is not ready (disconnected from a USB device) */
  77                         Status_USBEnumerating   = 1, /**< USB interface is enumerating */
  78                         Status_USBReady         = 2, /**< USB interface is connected and ready */
  79                         Status_EnumerationError = 3, /**< Software error while enumerating the attached USB device */
  80                         Status_HardwareError    = 4, /**< Hardware error while enumerating the attached USB device */
  81                 };
  82
  83         /* Task Definitions: */
  84                 TASK(USB_Keyboard_Host);
  85
  86         /* Function Prototypes: */
  87                 void EVENT_USB_HostError(const uint8_t ErrorCode);
  88                 void EVENT_USB_DeviceAttached(void);
  89                 void EVENT_USB_DeviceUnattached(void);
  90                 void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
  91                 void EVENT_USB_DeviceEnumerationComplete(void);
  92
  93                 void UpdateStatus(uint8_t CurrentStatus);
  94                 void ReadNextReport(void);
  95
  96 #endif