Keyboard.h 5.69 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
11
      Based on code by Dean Camera (dean [at] fourwalledcubicle [dot] com)
12

13
14
15
16
17
18
19
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting 
  documentation, and that the name of the author not be used in 
  advertising or publicity pertaining to distribution of the 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Header file for Keyboard.c.
 */
36

37
38
39
40
41
42
#ifndef _KEYBOARD_H_
#define _KEYBOARD_H_

	/* Includes: */
		#include <avr/io.h>
		#include <avr/wdt.h>
43
		#include <avr/power.h>
44
45
46
47
48
		#include <stdbool.h>
		#include <string.h>

		#include "Descriptors.h"

49
50
51
		#include <LUFA/Version.h>
		#include <LUFA/Drivers/USB/USB.h>
		#include <LUFA/Drivers/Board/Joystick.h>
52
		#include <LUFA/Drivers/Board/Buttons.h>
53
		#include <LUFA/Drivers/Board/LEDs.h>
54
55
56

	/* Macros: */
		/** 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
		#define REQ_SetProtocol             0x0B

		/** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */
		#define KEYBOARD_MODIFER_LEFTCTRL   (1 << 0)

		/** Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed. */
		#define KEYBOARD_MODIFER_LEFTSHIFT  (1 << 1)

		/** Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed. */
		#define KEYBOARD_MODIFER_LEFTALT    (1 << 2)

		/** Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed. */
		#define KEYBOARD_MODIFER_LEFTGUI    (1 << 3)

		/** Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed. */
		#define KEYBOARD_MODIFER_RIGHTCTRL  (1 << 4)

		/** Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed. */
		#define KEYBOARD_MODIFER_RIGHTSHIFT (1 << 5)

		/** Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed. */
		#define KEYBOARD_MODIFER_RIGHTALT   (1 << 6)

		/** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */
		#define KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)
100
101

		/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
102
		#define LEDMASK_USB_NOTREADY        LEDS_LED1
103
104

		/** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
105
		#define LEDMASK_USB_ENUMERATING     (LEDS_LED2 | LEDS_LED3)
106
107

		/** LED mask for the library LED driver, to indicate that the USB interface is ready. */
108
		#define LEDMASK_USB_READY           (LEDS_LED2 | LEDS_LED4)
109
110

		/** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
111
		#define LEDMASK_USB_ERROR           (LEDS_LED1 | LEDS_LED3)
112

113
114
115
116
117
118
119
120
121
122
123
124
	/* Type Defines: */
		/** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.
		 *  This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
		 */
		typedef struct
		{
			uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */
			uint8_t Reserved; /**< Reserved, always set as 0x00 */
			uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */
		} USB_KeyboardReport_Data_t;
		
	/* Function Prototypes: */
125
126
127
		void SetupHardware(void);
		void HID_Task(void);
	
128
129
130
131
		void EVENT_USB_Device_Connect(void);
		void EVENT_USB_Device_Disconnect(void);
		void EVENT_USB_Device_ConfigurationChanged(void);
		void EVENT_USB_Device_UnhandledControlRequest(void);
132
		void EVENT_USB_Device_StartOfFrame(void);
133

134
135
136
137
		void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);
		void ProcessLEDReport(uint8_t LEDReport);
		void SendNextReport(void);
		void ReceiveNextReport(void);
138

139
#endif