Keyboard.c 11.6 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
*/

/*
10
  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12
  Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)

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
18
19
  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
36
  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 Keyboard demo. This file contains the main tasks of the demo and
 *  is responsible for the initial application hardware configuration.
 */
37

38
39
40
41
42
#include "Keyboard.h"

/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot
 *  protocol reporting mode.
 */
43
static bool UsingReportProtocol = true;
44
45
46
47

/** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports
 *  for either the entire idle duration, or until the report status changes (e.g. the user presses a key).
 */
48
static uint16_t IdleCount = 500;
49
50

/** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle
51
 *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request
52
53
 *  the current idle period via a Get Idle HID class request, thus its value must be preserved.
 */
54
static uint16_t IdleMSRemaining = 0;
55
56
57
58
59
60
61
62


/** Main program entry point. This routine configures the hardware required by the application, then
 *  enters a loop to run the application tasks in sequence.
 */
int main(void)
{
	SetupHardware();
63

64
65
66
67
68
69
70
71
72
73
74
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
	sei();

	for (;;)
	{
		HID_Task();
		USB_USBTask();
	}
}

/** Configures the board hardware and chip peripherals for the demo's functionality. */
void SetupHardware(void)
{
	/* Disable watchdog if enabled by bootloader/fuses */
	MCUSR &= ~(1 << WDRF);
	wdt_disable();

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

	/* Hardware Initialization */
	Joystick_Init();
	LEDs_Init();
	USB_Init();
	Buttons_Init();
}

/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
 *  starts the library USB task to begin the enumeration and USB management process.
 */
void EVENT_USB_Device_Connect(void)
{
	/* Indicate USB enumerating */
	LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);

	/* Default to report protocol on connect */
	UsingReportProtocol = true;
}

/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
 *  the status LEDs.
 */
void EVENT_USB_Device_Disconnect(void)
{
	/* Indicate USB not ready */
	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
}

/** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
 *  of the USB device after enumeration, and configures the keyboard device endpoints.
 */
void EVENT_USB_Device_ConfigurationChanged(void)
116
{
117
	bool ConfigSuccess = true;
118

119
120
121
122
123
124
	/* Setup HID Report Endpoints */
	ConfigSuccess &= Endpoint_ConfigureEndpoint(KEYBOARD_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
	                                            KEYBOARD_EPSIZE, ENDPOINT_BANK_SINGLE);
	ConfigSuccess &= Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT,
	                                            KEYBOARD_EPSIZE, ENDPOINT_BANK_SINGLE);

125
	/* Turn on Start-of-Frame events for tracking HID report period expiry */
126
	USB_Device_EnableSOFEvents();
127
128

	/* Indicate endpoint configuration success or failure */
129
	LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
130
131
}

132
133
134
/** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
 *  the device from the USB host before passing along unhandled control requests to the library for processing
 *  internally.
135
 */
136
void EVENT_USB_Device_ControlRequest(void)
137
138
139
140
{
	/* Handle HID Class specific requests */
	switch (USB_ControlRequest.bRequest)
	{
141
		case HID_REQ_GetReport:
142
143
144
145
146
147
148
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
			{
				USB_KeyboardReport_Data_t KeyboardReportData;

				/* Create the next keyboard report for transmission to the host */
				CreateKeyboardReport(&KeyboardReportData);

149
150
				Endpoint_ClearSETUP();

151
152
153
154
				/* Write the report data to the control endpoint */
				Endpoint_Write_Control_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
				Endpoint_ClearOUT();
			}
155

156
			break;
157
		case HID_REQ_SetReport:
158
159
160
			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
			{
				Endpoint_ClearSETUP();
161

162
163
164
165
166
167
168
169
				/* Wait until the LED report has been sent by the host */
				while (!(Endpoint_IsOUTReceived()))
				{
					if (USB_DeviceState == DEVICE_STATE_Unattached)
					  return;
				}

				/* Read in the LED report from the host */
170
				uint8_t LEDStatus = Endpoint_Read_8();
171
172
173

				Endpoint_ClearOUT();
				Endpoint_ClearStatusStage();
174
175
176

				/* Process the incoming LED report */
				ProcessLEDReport(LEDStatus);
177
			}
178

179
			break;
180
		case HID_REQ_GetProtocol:
181
182
183
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
			{
				Endpoint_ClearSETUP();
184

185
				/* Write the current protocol flag to the host */
186
				Endpoint_Write_8(UsingReportProtocol);
187

188
				Endpoint_ClearIN();
189
190
				Endpoint_ClearStatusStage();
			}
191

192
			break;
193
		case HID_REQ_SetProtocol:
194
195
196
			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
			{
				Endpoint_ClearSETUP();
197
				Endpoint_ClearStatusStage();
198
199
200
201

				/* Set or clear the flag depending on what the host indicates that the current Protocol should be */
				UsingReportProtocol = (USB_ControlRequest.wValue != 0);
			}
202

203
			break;
204
		case HID_REQ_SetIdle:
205
206
			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
			{
207
				Endpoint_ClearSETUP();
208
209
				Endpoint_ClearStatusStage();

210
211
212
				/* Get idle period in MSB, IdleCount must be multiplied by 4 to get number of milliseconds */
				IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
			}
213

214
			break;
215
		case HID_REQ_GetIdle:
216
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
217
			{
218
				Endpoint_ClearSETUP();
219

220
				/* Write the current idle duration to the host, must be divided by 4 before sent to host */
221
				Endpoint_Write_8(IdleCount >> 2);
222

223
				Endpoint_ClearIN();
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
				Endpoint_ClearStatusStage();
			}

			break;
	}
}

/** Event handler for the USB device Start Of Frame event. */
void EVENT_USB_Device_StartOfFrame(void)
{
	/* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */
	if (IdleMSRemaining)
	  IdleMSRemaining--;
}

/** Fills the given HID report data structure with the next HID report to send to the host.
 *
 *  \param[out] ReportData  Pointer to a HID report data structure to be filled
 */
243
void CreateKeyboardReport(USB_KeyboardReport_Data_t* const ReportData)
244
245
246
247
248
249
250
251
{
	uint8_t JoyStatus_LCL     = Joystick_GetStatus();
	uint8_t ButtonStatus_LCL  = Buttons_GetStatus();

	uint8_t UsedKeyCodes      = 0;

	/* Clear the report contents */
	memset(ReportData, 0, sizeof(USB_KeyboardReport_Data_t));
252

253
	/* Make sent key uppercase by indicating that the left shift key is pressed */
254
	ReportData->Modifier = HID_KEYBOARD_MODIFIER_LEFTSHIFT;
255

256
	if (JoyStatus_LCL & JOY_UP)
257
	  ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_A;
258
	else if (JoyStatus_LCL & JOY_DOWN)
259
	  ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_B;
260
261

	if (JoyStatus_LCL & JOY_LEFT)
262
	  ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_C;
263
	else if (JoyStatus_LCL & JOY_RIGHT)
264
	  ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_D;
265
266

	if (JoyStatus_LCL & JOY_PRESS)
267
	  ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_E;
268

269
	if (ButtonStatus_LCL & BUTTONS_BUTTON1)
270
	  ReportData->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_F;
271
272
273
274
275
276
}

/** Processes a received LED report, and updates the board LEDs states to match.
 *
 *  \param[in] LEDReport  LED status report from the host
 */
277
void ProcessLEDReport(const uint8_t LEDReport)
278
279
{
	uint8_t LEDMask = LEDS_LED2;
280

281
	if (LEDReport & HID_KEYBOARD_LED_NUMLOCK)
282
	  LEDMask |= LEDS_LED1;
283

284
	if (LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
285
286
	  LEDMask |= LEDS_LED3;

287
	if (LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
288
289
290
291
292
293
294
295
296
297
298
299
	  LEDMask |= LEDS_LED4;

	/* Set the status LEDs to the current Keyboard LED status */
	LEDs_SetAllLEDs(LEDMask);
}

/** Sends the next HID report to the host, via the keyboard data endpoint. */
void SendNextReport(void)
{
	static USB_KeyboardReport_Data_t PrevKeyboardReportData;
	USB_KeyboardReport_Data_t        KeyboardReportData;
	bool                             SendReport = true;
300

301
302
	/* Create the next keyboard report for transmission to the host */
	CreateKeyboardReport(&KeyboardReportData);
303

304
305
	/* Check to see if the report data has changed - if so a report MUST be sent */
	SendReport = (memcmp(&PrevKeyboardReportData, &KeyboardReportData, sizeof(USB_KeyboardReport_Data_t)) != 0);
306

307
	/* Check if the idle period is set and has elapsed */
308
	if (IdleCount && (!(IdleMSRemaining)))
309
310
311
	{
		/* Reset the idle time remaining counter */
		IdleMSRemaining = IdleCount;
312

313
314
315
		/* Idle period is set and has elapsed, must send a report to the host */
		SendReport = true;
	}
316

317
	/* Select the Keyboard Report Endpoint */
318
	Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);
319
320
321
322
323
324

	/* Check if Keyboard Endpoint Ready for Read/Write and if we should send a new report */
	if (Endpoint_IsReadWriteAllowed() && SendReport)
	{
		/* Save the current report data for later comparison to check for changes */
		PrevKeyboardReportData = KeyboardReportData;
325

326
		/* Write Keyboard Report Data */
327
		Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData), NULL);
328

329
330
331
332
333
334
335
336
337
		/* Finalize the stream transfer to send the last packet */
		Endpoint_ClearIN();
	}
}

/** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */
void ReceiveNextReport(void)
{
	/* Select the Keyboard LED Report Endpoint */
338
	Endpoint_SelectEndpoint(KEYBOARD_OUT_EPNUM);
339
340
341
342
343
344
345
346

	/* Check if Keyboard LED Endpoint contains a packet */
	if (Endpoint_IsOUTReceived())
	{
		/* Check to see if the packet contains data */
		if (Endpoint_IsReadWriteAllowed())
		{
			/* Read in the LED report from the host */
347
			uint8_t LEDReport = Endpoint_Read_8();
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363

			/* Process the read LED report from the host */
			ProcessLEDReport(LEDReport);
		}

		/* Handshake the OUT Endpoint - clear endpoint and ready for next report */
		Endpoint_ClearOUT();
	}
}

/** Function to manage HID report generation and transmission to the host, when in report mode. */
void HID_Task(void)
{
	/* Device must be connected and configured for the task to run */
	if (USB_DeviceState != DEVICE_STATE_Configured)
	  return;
364

365
366
	/* Send the next keypress report to the host */
	SendNextReport();
367

368
369
370
	/* Process the LED report sent from the host */
	ReceiveNextReport();
}
371