KeyboardHostWithParser.c 9.27 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, 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
  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
 *
 *  Main source file for the KeyboardHostWithParser demo. This file contains the main tasks of
 *  the demo and is responsible for the initial application hardware configuration.
 */
 
#include "KeyboardHostWithParser.h"

/** Main program entry point. This routine configures the hardware required by the application, then
 *  starts the scheduler to run the application tasks.
 */
int main(void)
43
44
45
{
	SetupHardware();

46
	puts_P(PSTR(ESC_FG_CYAN "Keyboard HID Parser Host Demo running.\r\n" ESC_FG_WHITE));
47
48
49
50
51
52
53
54
55
56
57
58

	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);

	for (;;)
	{
		Keyboard_HID_Task();
		USB_USBTask();
	}
}

/** Configures the board hardware and chip peripherals for the demo's functionality. */
void SetupHardware(void)
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
{
	/* Disable watchdog if enabled by bootloader/fuses */
	MCUSR &= ~(1 << WDRF);
	wdt_disable();

	/* Disable clock division */
	clock_prescale_set(clock_div_1);

	/* Hardware Initialization */
	SerialStream_Init(9600, false);
	LEDs_Init();
	USB_Init();
}

/** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 *  starts the library USB task to begin the enumeration and USB management process.
 */
void EVENT_USB_DeviceAttached(void)
{
78
	puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
79
	LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
80
81
82
83
84
85
86
}

/** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 *  stops the library USB task management process.
 */
void EVENT_USB_DeviceUnattached(void)
{
87
	puts_P(PSTR(ESC_FG_GREEN "\r\nDevice Unattached.\r\n" ESC_FG_WHITE));
88
	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
89
90
91
92
93
94
95
}

/** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 *  enumerated by the host and is now ready to be used by the application.
 */
void EVENT_USB_DeviceEnumerationComplete(void)
{
96
	LEDs_SetAllLEDs(LEDMASK_USB_READY);
97
98
99
100
101
102
103
}

/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
void EVENT_USB_HostError(const uint8_t ErrorCode)
{
	USB_ShutDown();

104
105
	puts_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"));
	printf_P(PSTR(" -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
106

107
	LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
108
109
110
111
112
113
114
115
	for(;;);
}

/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 *  enumerating an attached USB device.
 */
void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
{
116
	puts_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"));
117
118
	printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
	printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
119
	printf_P(PSTR(" -- In State %d\r\n" ESC_FG_WHITE), USB_HostState);
120
	
121
	LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
122
123
124
125
126
}

/** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 *  the HID report descriptor and HID reports from the device and display the results onto the board LEDs.
 */
127
void Keyboard_HID_Task(void)
128
129
130
131
132
133
134
135
136
137
138
139
{
	uint8_t ErrorCode;

	switch (USB_HostState)
	{
		case HOST_STATE_Addressed:
			puts_P(PSTR("Getting Config Data.\r\n"));
		
			/* Get and process the configuration descriptor data */
			if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
			{
				if (ErrorCode == ControlError)
140
				  puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
141
				else
142
				  puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
143

144
				printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
145
146
				
				/* Indicate error via status LEDs */
147
				LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
148
149

				/* Wait until USB device disconnected */
150
				USB_HostState = HOST_STATE_WaitForDeviceRemoval;
151
152
				break;
			}
153
154
155
156
157

			/* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
			if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)

			{
158
159
				puts_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"));
				printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
160
161
162
163
164

				/* Indicate error via status LEDs */
				LEDs_SetAllLEDs(LEDMASK_USB_ERROR);

				/* Wait until USB device disconnected */
165
				USB_HostState = HOST_STATE_WaitForDeviceRemoval;
166
167
168
				break;
			}
				
169
170
171
172
173
			puts_P(PSTR("Processing HID Report.\r\n"));

			/* Get and process the device's first HID report descriptor */
			if ((ErrorCode = GetHIDReportData()) != ParseSuccessful)
			{
174
175
				puts_P(PSTR(ESC_FG_RED "Report Parse Error.\r\n"));
				printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
176
177
			
				/* Indicate error via status LEDs */
178
				LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
179
180
				
				/* Wait until USB device disconnected */
181
				USB_HostState = HOST_STATE_WaitForDeviceRemoval;
182
183
184
185
186
				break;	
			}

			puts_P(PSTR("Keyboard Enumerated.\r\n"));

187
			USB_HostState = HOST_STATE_Configured;
188
			break;
189
		case HOST_STATE_Configured:
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
			/* Select and unfreeze keyboard data pipe */
			Pipe_SelectPipe(KEYBOARD_DATAPIPE);	
			Pipe_Unfreeze();

			/* Check to see if a packet has been received */
			if (Pipe_IsINReceived())
			{
				/* Check if data has been received from the attached keyboard */
				if (Pipe_IsReadWriteAllowed())
				{
					/* Create buffer big enough for the report */
					uint8_t KeyboardReport[Pipe_BytesInPipe()];

					/* Load in the keyboard report */
					Pipe_Read_Stream_LE(KeyboardReport, Pipe_BytesInPipe());
				
					/* Process the read in keyboard report from the device */
					ProcessKeyboardReport(KeyboardReport);
				}
				
				/* Clear the IN endpoint, ready for next data packet */
				Pipe_ClearIN();
			}

			/* Freeze keyboard data pipe */
			Pipe_Freeze();
			break;
	}
}

/** Processes a read HID report from an attached keyboard, extracting out elements via the HID parser results
 *  as required and prints pressed characters to the serial port. Each time a key is typed, a board LED is toggled.
 *
223
 *  \param[in] KeyboardReport  Pointer to a HID report from an attached keyboard device
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 */
void ProcessKeyboardReport(uint8_t* KeyboardReport)
{
	/* Check each HID report item in turn, looking for keyboard scan code reports */
	for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
	{
		/* Create a temporary item pointer to the next report item */
		HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];

		/* Check if the current report item is a keyboard scancode */
		if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
			(ReportItem->Attributes.BitSize         == 8)                   &&
			(ReportItem->Attributes.Logical.Maximum > 1)                    &&
			(ReportItem->ItemType                   == REPORT_ITEM_TYPE_In))
		{
			/* Retrieve the keyboard scancode from the report data retrieved from the device */
			bool FoundData = USB_GetHIDReportItemInfo(KeyboardReport, ReportItem);
			
			/* For multi-report devices - if the requested data was not in the issued report, continue */
			if (!(FoundData))
			  continue;
			
			/* Key code is an unsigned char in length, cast to the appropriate type */
			uint8_t KeyCode = (uint8_t)ReportItem->Value;

			/* If scancode is non-zero, a key is being pressed */
			if (KeyCode)
			{
				/* Toggle status LED to indicate keypress */
253
				LEDs_ToggleLEDs(LEDS_LED2);
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

				char PressedKey = 0;

				/* Convert scancode to printable character if alphanumeric */
				if ((KeyCode >= 0x04) && (KeyCode <= 0x1D))
				  PressedKey = (KeyCode - 0x04) + 'A';
				else if ((KeyCode >= 0x1E) && (KeyCode <= 0x27))
				  PressedKey = (KeyCode - 0x1E) + '0';
				else if (KeyCode == 0x2C)
				  PressedKey = ' ';						
				else if (KeyCode == 0x28)
				  PressedKey = '\n';
					 
				/* Print the pressed key character out through the serial port if valid */
				if (PressedKey)
				  putchar(PressedKey);
			}
			
			/* Once a scancode is found, stop scanning through the report items */
			break;
		}
	}
}