Keyboard.c 15.4 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
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
  Copyright 2009  Denver Gingerich (denver [at] ossguy [dot] com)
      Based on code by 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
 *
34
 *  Main source file for the Keyboard demo. This file contains the main tasks of the demo and
35
36
37
38
39
40
41
42
 *  is responsible for the initial application hardware configuration.
 */
 
#include "Keyboard.h"

/* Scheduler Task List */
TASK_LIST
{
43
	#if !defined(INTERRUPT_CONTROL_ENDPOINT)
44
	{ .Task = USB_USBTask          , .TaskStatus = TASK_STOP },
45
46
	#endif
	
47
	{ .Task = USB_Keyboard_Report  , .TaskStatus = TASK_STOP },
48
49
50
51
52
53
54
55
56
};

/* Global Variables */
/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot
 *  protocol reporting mode.
 */
bool UsingReportProtocol = true;

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

/** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle
62
 *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request 
63
64
65
66
67
68
 *  the current idle period via a Get Idle HID class request, thus its value must be preserved.
 */
uint16_t IdleMSRemaining = 0;


/** Main program entry point. This routine configures the hardware required by the application, then
69
 *  starts the scheduler to run the USB management task.
70
71
72
73
74
75
76
 */
int main(void)
{
	/* Disable watchdog if enabled by bootloader/fuses */
	MCUSR &= ~(1 << WDRF);
	wdt_disable();

77
78
	/* Disable clock division */
	clock_prescale_set(clock_div_1);
79
80
81
82
83
84
85
86
87
88
89
90
91

	/* Hardware Initialization */
	Joystick_Init();
	LEDs_Init();
	
	/* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */
	OCR0A  = 0x7D;
	TCCR0A = (1 << WGM01);
	TCCR0B = ((1 << CS01) | (1 << CS00));
	TIMSK0 = (1 << OCIE0A);

	/* Indicate USB not ready */
	UpdateStatus(Status_USBNotReady);
92

93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
	/* Initialize Scheduler so that it can be used */
	Scheduler_Init();

	/* Initialize USB Subsystem */
	USB_Init();
	
	/* Scheduling - routine never returns, so put this last in the main function */
	Scheduler_Start();
}

/** 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.
 */
EVENT_HANDLER(USB_Connect)
{
108
109
110
111
112
	#if !defined(INTERRUPT_CONTROL_ENDPOINT)
	/* Start USB management task */
	Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
	#endif

113
114
	/* Indicate USB enumerating */
	UpdateStatus(Status_USBEnumerating);
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

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

/** Event handler for the USB_Reset event. This fires when the USB interface is reset by the USB host, before the
 *  enumeration process begins, and enables the control endpoint interrupt so that control requests can be handled
 *  asynchronously when they arrive rather than when the control endpoint is polled manually.
 */
EVENT_HANDLER(USB_Reset)
{
	#if defined(INTERRUPT_CONTROL_ENDPOINT)
	/* Select the control endpoint */
	Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);

	/* Enable the endpoint SETUP interrupt ISR for the control endpoint */
	USB_INT_Enable(ENDPOINT_INT_SETUP);
	#endif
133
134
135
}

/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
136
 *  the status LEDs.
137
138
139
 */
EVENT_HANDLER(USB_Disconnect)
{
140
141
142
143
144
145
146
	/* Stop running keyboard reporting and USB management tasks */
	Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);

	#if !defined(INTERRUPT_CONTROL_ENDPOINT)
	Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
	#endif
	
147
148
149
150
	/* Indicate USB not ready */
	UpdateStatus(Status_USBNotReady);
}

151
152
153
/** 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.
 */
154
155
156
157
158
159
160
161
162
163
164
165
166
167
EVENT_HANDLER(USB_ConfigurationChanged)
{
	/* Setup Keyboard Keycode Report Endpoint */
	Endpoint_ConfigureEndpoint(KEYBOARD_EPNUM, EP_TYPE_INTERRUPT,
		                       ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,
	                           ENDPOINT_BANK_SINGLE);

	/* Setup Keyboard LED Report Endpoint */
	Endpoint_ConfigureEndpoint(KEYBOARD_LEDS_EPNUM, EP_TYPE_INTERRUPT,
		                       ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE,
	                           ENDPOINT_BANK_SINGLE);

	/* Indicate USB connected and ready */
	UpdateStatus(Status_USBReady);
168
169
170

	/* Start running keyboard reporting task */
	Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);
171
172
173
174
175
176
177
178
179
}

/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
 *  control requests that are not handled internally by the USB library (including the HID commands, which are
 *  all issued via the control endpoint), so that they can be handled appropriately for the application.
 */
EVENT_HANDLER(USB_UnhandledControlPacket)
{
	/* Handle HID Class specific requests */
180
	switch (USB_ControlRequest.bRequest)
181
182
	{
		case REQ_GetReport:
183
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
184
185
186
			{
				USB_KeyboardReport_Data_t KeyboardReportData;

187
188
				Endpoint_ClearSETUP();
	
189
				/* Create the next keyboard report for transmission to the host */
190
				CreateKeyboardReport(&KeyboardReportData);
191
192

				/* Write the report data to the control endpoint */
193
				Endpoint_Write_Control_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
194
195
				
				/* Finalize the stream transfer to send the last packet or clear the host abort */
196
				Endpoint_ClearOUT();
197
198
199
200
			}
		
			break;
		case REQ_SetReport:
201
			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
202
			{
203
				Endpoint_ClearSETUP();
204
205
				
				/* Wait until the LED report has been sent by the host */
206
				while (!(Endpoint_IsOUTReceived()));
207
208
209
210

				/* Read in the LED report from the host */
				uint8_t LEDStatus = Endpoint_Read_Byte();

211
				/* Process the incoming LED report */
212
213
214
				ProcessLEDReport(LEDStatus);
			
				/* Clear the endpoint data */
215
				Endpoint_ClearOUT();
216

217
				/* Acknowledge status stage */
218
				while (!(Endpoint_IsINReady()));
219
				Endpoint_ClearIN();
220
221
222
223
			}
			
			break;
		case REQ_GetProtocol:
224
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
225
			{
226
				Endpoint_ClearSETUP();
227
228
229
230
231
				
				/* Write the current protocol flag to the host */
				Endpoint_Write_Byte(UsingReportProtocol);
				
				/* Send the flag to the host */
232
				Endpoint_ClearIN();
233

234
				/* Acknowledge status stage */
235
				while (!(Endpoint_IsOUTReceived()));
236
				Endpoint_ClearOUT();
237
238
239
240
			}
			
			break;
		case REQ_SetProtocol:
241
			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
242
			{
243
				Endpoint_ClearSETUP();
244
245

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

248
				/* Acknowledge status stage */
249
				while (!(Endpoint_IsINReady()));
250
				Endpoint_ClearIN();
251
252
253
254
			}
			
			break;
		case REQ_SetIdle:
255
			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
256
			{
257
				Endpoint_ClearSETUP();
258
259
				
				/* Get idle period in MSB */
260
				IdleCount = (USB_ControlRequest.wValue >> 8);
261
				
262
				/* Acknowledge status stage */
263
				while (!(Endpoint_IsINReady()));
264
				Endpoint_ClearIN();
265
266
267
268
			}
			
			break;
		case REQ_GetIdle:
269
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
270
			{		
271
				Endpoint_ClearSETUP();
272
273
274
275
276
				
				/* Write the current idle duration to the host */
				Endpoint_Write_Byte(IdleCount);
				
				/* Send the flag to the host */
277
				Endpoint_ClearIN();
278
279

				/* Acknowledge status stage */
280
				while (!(Endpoint_IsOUTReceived()));
281
				Endpoint_ClearOUT();
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
			}

			break;
	}
}

/** ISR for the timer 0 compare vector. This ISR fires once each millisecond, and increments the
 *  scheduler elapsed idle period counter when the host has set an idle period.
 */
ISR(TIMER0_COMPA_vect, ISR_BLOCK)
{
	/* 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 ReportData  Pointer to a HID report data structure to be filled
 */
302
void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData)
303
{
304
	uint8_t JoyStatus_LCL = Joystick_GetStatus();
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322

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

	if (JoyStatus_LCL & JOY_UP)
	  ReportData->KeyCode[0] = 0x04; // A
	else if (JoyStatus_LCL & JOY_DOWN)
	  ReportData->KeyCode[0] = 0x05; // B

	if (JoyStatus_LCL & JOY_LEFT)
	  ReportData->KeyCode[0] = 0x06; // C
	else if (JoyStatus_LCL & JOY_RIGHT)
	  ReportData->KeyCode[0] = 0x07; // D

	if (JoyStatus_LCL & JOY_PRESS)
	  ReportData->KeyCode[0] = 0x08; // E
}

323
/** Processes a received LED report, and updates the board LEDs states to match.
324
 *
325
 *  \param LEDReport  LED status report from the host
326
327
328
 */
void ProcessLEDReport(uint8_t LEDReport)
{
329
	uint8_t LEDMask = LEDS_LED2;
330
331
332
333
334
335
336
337
338
339
340
341
342
343
	
	if (LEDReport & 0x01) // NUM Lock
	  LEDMask |= LEDS_LED1;
	
	if (LEDReport & 0x02) // CAPS Lock
	  LEDMask |= LEDS_LED3;

	if (LEDReport & 0x04) // SCROLL Lock
	  LEDMask |= LEDS_LED4;

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

344
/** Sends the next HID report to the host, via the keyboard data endpoint. */
345
void SendNextReport(void)
346
{
347
348
349
	static USB_KeyboardReport_Data_t PrevKeyboardReportData;
	USB_KeyboardReport_Data_t        KeyboardReportData;
	bool                             SendReport = true;
350
351
	
	/* Create the next keyboard report for transmission to the host */
352
	CreateKeyboardReport(&KeyboardReportData);
353
	
354
355
	/* 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);
356
	
357
358
	/* Save the current report data for later comparison to check for changes */
	PrevKeyboardReportData = KeyboardReportData;
359
360
361
362
363
364
365
366
367
368
369
	
	/* Check if the idle period is set and has elapsed */
	if ((IdleCount != HID_IDLE_CHANGESONLY) && (!(IdleMSRemaining)))
	{
		/* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */
		IdleMSRemaining = (IdleCount << 2);
		
		/* Idle period is set and has elapsed, must send a report to the host */
		SendReport = true;
	}
	
370
371
372
	/* Select the Keyboard Report Endpoint */
	Endpoint_SelectEndpoint(KEYBOARD_EPNUM);

373
	/* Check if Keyboard Endpoint Ready for Read/Write and if we should send a new report */
374
	if (Endpoint_IsReadWriteAllowed() && SendReport)
375
376
377
	{
		/* Write Keyboard Report Data */
		Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
378
		
379
		/* Finalize the stream transfer to send the last packet */
380
		Endpoint_ClearIN();
381
382
383
384
	}
}

/** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */
385
void ReceiveNextReport(void)
386
387
388
389
{
	/* Select the Keyboard LED Report Endpoint */
	Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);

390
391
392
393
394
395
396
397
	/* 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 */
			uint8_t LEDReport = Endpoint_Read_Byte();
398

399
400
401
			/* Process the read LED report from the host */
			ProcessLEDReport(LEDReport);
		}
402

403
404
405
		/* Handshake the OUT Endpoint - clear endpoint and ready for next report */
		Endpoint_ClearOUT();
	}
406
407
}

408
409
410
/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to
 *  log to a serial port, or anything else that is suitable for status updates.
 *
411
 *  \param CurrentStatus  Current status of the system, from the Keyboard_StatusCodes_t enum
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 */
void UpdateStatus(uint8_t CurrentStatus)
{
	uint8_t LEDMask = LEDS_NO_LEDS;
	
	/* Set the LED mask to the appropriate LED mask based on the given status code */
	switch (CurrentStatus)
	{
		case Status_USBNotReady:
			LEDMask = (LEDS_LED1);
			break;
		case Status_USBEnumerating:
			LEDMask = (LEDS_LED1 | LEDS_LED2);
			break;
		case Status_USBReady:
			LEDMask = (LEDS_LED2 | LEDS_LED4);
			break;
	}
	
	/* Set the board LEDs to the new LED mask */
	LEDs_SetAllLEDs(LEDMask);
}

/** Function to manage HID report generation and transmission to the host, when in report mode. */
TASK(USB_Keyboard_Report)
{
438
439
	/* Check if the USB system is connected to a host */
	if (USB_IsConnected)
440
	{
441
442
		/* Send the next keypress report to the host */
		SendNextReport();
443
		
444
445
		/* Process the LED report sent from the host */
		ReceiveNextReport();
446
	}
447
448
}

449
#if defined(INTERRUPT_CONTROL_ENDPOINT)
450
451
452
453
454
455
456
457
/** ISR for the general Pipe/Endpoint interrupt vector. This ISR fires when an endpoint's status changes (such as
 *  a packet has been received) on an endpoint with its corresponding ISR enabling bits set. This is used to send
 *  HID packets to the host each time the HID interrupt endpoints polling period elapses, as managed by the USB
 *  controller. It is also used to respond to standard and class specific requests send to the device on the control
 *  endpoint, by handing them off to the LUFA library when they are received.
 */
ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)
{
458
459
460
	/* Save previously selected endpoint before selecting a new endpoint */
	uint8_t PrevSelectedEndpoint = Endpoint_GetCurrentEndpoint();

461
462
463
464
465
466
467
468
469
	/* Check if the control endpoint has received a request */
	if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))
	{
		/* Process the control request */
		USB_USBTask();

		/* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */
		USB_INT_Clear(ENDPOINT_INT_SETUP);
	}
470
471
472
	
	/* Restore previously selected endpoint */
	Endpoint_SelectEndpoint(PrevSelectedEndpoint);	
473
}
474
#endif