Mouse.c 13.7 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
/*
             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 Mouse demo. This file contains the main tasks of the demo and
 *  is responsible for the initial application hardware configuration.
 */
 
#include "Mouse.h"

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

/* 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
 *  for either the entire idle duration, or until the report status changes (e.g. the user moves the mouse).
 */
58
uint16_t IdleCount = HID_IDLE_CHANGESONLY;
59
60

/** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle
61
 *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 *  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
 *  starts the scheduler to run the application tasks.
 */
int main(void)
{
	/* Disable watchdog if enabled by bootloader/fuses */
	MCUSR &= ~(1 << WDRF);
	wdt_disable();

76
77
	/* Disable clock division */
	clock_prescale_set(clock_div_1);
78
79
80
81

	/* Hardware Initialization */
	Joystick_Init();
	LEDs_Init();
82
	Buttons_Init();
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
	
	/* 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);
	
	/* 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
	#if !defined(INTERRUPT_CONTROL_ENDPOINT)
109
110
	/* Start USB management task */
	Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
111
112
	#endif
	
113
114
	/* Indicate USB enumerating */
	UpdateStatus(Status_USBEnumerating);
115
116
117

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

120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/** 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
}

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

	#if !defined(INTERRUPT_CONTROL_ENDPOINT)
144
	Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
145
	#endif
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

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

/** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
 *  of the USB device after enumeration - the device endpoints are configured and the mouse reporting task started.
 */ 
EVENT_HANDLER(USB_ConfigurationChanged)
{
	/* Setup Mouse Report Endpoint */
	Endpoint_ConfigureEndpoint(MOUSE_EPNUM, EP_TYPE_INTERRUPT,
		                       ENDPOINT_DIR_IN, MOUSE_EPSIZE,
	                           ENDPOINT_BANK_SINGLE);

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

	/* Start running mouse reporting task */
	Scheduler_SetTaskMode(USB_Mouse_Report, TASK_RUN);
}

/** 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 */
175
	switch (USB_ControlRequest.bRequest)
176
177
	{
		case REQ_GetReport:
178
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
179
180
181
			{
				USB_MouseReport_Data_t MouseReportData;

182
183
				Endpoint_ClearSETUP();

184
				/* Create the next mouse report for transmission to the host */
185
				CreateMouseReport(&MouseReportData);
186
187
	
				/* Write the report data to the control endpoint */
188
				Endpoint_Write_Control_Stream_LE(&MouseReportData, sizeof(MouseReportData));
189
190
191
192
193
				
				/* Clear the report data afterwards */
				memset(&MouseReportData, 0, sizeof(MouseReportData));

				/* Finalize the stream transfer to send the last packet or clear the host abort */
194
				Endpoint_ClearOUT();
195
196
197
198
			}
		
			break;
		case REQ_GetProtocol:
199
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
200
			{
201
				Endpoint_ClearSETUP();
202
203
204
205
206
				
				/* Write the current protocol flag to the host */
				Endpoint_Write_Byte(UsingReportProtocol);
				
				/* Send the flag to the host */
207
				Endpoint_ClearIN();
208
209

				/* Acknowledge status stage */
210
				while (!(Endpoint_IsOUTReceived()));
211
				Endpoint_ClearOUT();
212
213
214
215
			}
			
			break;
		case REQ_SetProtocol:
216
			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
217
			{
218
				Endpoint_ClearSETUP();
219
220
				
				/* Set or clear the flag depending on what the host indicates that the current Protocol should be */
221
				UsingReportProtocol = (USB_ControlRequest.wValue != 0x0000);
222
				
223
				/* Acknowledge status stage */
224
				while (!(Endpoint_IsINReady()));
225
				Endpoint_ClearIN();
226
227
228
229
			}
			
			break;
		case REQ_SetIdle:
230
			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
231
			{
232
				Endpoint_ClearSETUP();
233
234
				
				/* Get idle period in MSB */
235
				IdleCount = (USB_ControlRequest.wValue >> 8);
236
				
237
				/* Acknowledge status stage */
238
				while (!(Endpoint_IsINReady()));
239
				Endpoint_ClearIN();
240
241
242
243
			}
			
			break;
		case REQ_GetIdle:
244
			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
245
			{		
246
				Endpoint_ClearSETUP();
247
248
249
250
251
				
				/* Write the current idle duration to the host */
				Endpoint_Write_Byte(IdleCount);
				
				/* Send the flag to the host */
252
				Endpoint_ClearIN();
253
254

				/* Acknowledge status stage */
255
				while (!(Endpoint_IsOUTReceived()));
256
				Endpoint_ClearOUT();
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
			}

			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
 */
277
void CreateMouseReport(USB_MouseReport_Data_t* ReportData)
278
{
279
280
	uint8_t JoyStatus_LCL    = Joystick_GetStatus();
	uint8_t ButtonStatus_LCL = Buttons_GetStatus();
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
	
	/* Clear the report contents */
	memset(ReportData, 0, sizeof(USB_MouseReport_Data_t));

	if (JoyStatus_LCL & JOY_UP)
	  ReportData->Y = -1;
	else if (JoyStatus_LCL & JOY_DOWN)
	  ReportData->Y =  1;

	if (JoyStatus_LCL & JOY_RIGHT)
	  ReportData->X =  1;
	else if (JoyStatus_LCL & JOY_LEFT)
	  ReportData->X = -1;

	if (JoyStatus_LCL & JOY_PRESS)
	  ReportData->Button  = (1 << 0);
	  
298
	if (ButtonStatus_LCL & BUTTONS_BUTTON1)
299
300
301
	  ReportData->Button |= (1 << 1);
}

302
/** Sends the next HID report to the host, via the keyboard data endpoint. */
303
void SendNextReport(void)
304
{
305
306
	static USB_MouseReport_Data_t PrevMouseReportData;
	USB_MouseReport_Data_t        MouseReportData;
307
	bool                          SendReport;
308
309
310
311
	
	/* Create the next mouse report for transmission to the host */
	CreateMouseReport(&MouseReportData);
	
312
313
314
315
316
317
318
319
	/* Check to see if the report data has changed - if so a report MUST be sent */
	SendReport = (memcmp(&PrevMouseReportData, &MouseReportData, sizeof(USB_MouseReport_Data_t)) != 0);
	
	/* Override the check if the Y or X values are non-zero - we want continuous movement while the joystick
	 * is being held down (via continuous reports), otherwise the cursor will only move once per joystick toggle */
	if ((MouseReportData.Y != 0) || (MouseReportData.X != 0))
	  SendReport = true;
	
320
321
	/* Save the current report data for later comparison to check for changes */
	PrevMouseReportData = MouseReportData;
322
	
323
324
325
326
327
328
329
330
331
332
	/* 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;
	}
	
333
334
335
336
	/* Select the Mouse Report Endpoint */
	Endpoint_SelectEndpoint(MOUSE_EPNUM);

	/* Check if Mouse Endpoint Ready for Read/Write and if we should send a new report */
337
	if (Endpoint_IsReadWriteAllowed() && SendReport)
338
339
340
341
342
	{
		/* Write Mouse Report Data */
		Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData));
		
		/* Finalize the stream transfer to send the last packet */
343
		Endpoint_ClearIN();
344
345
346
	}
}

347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/** 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.
 *
 *  \param CurrentStatus  Current status of the system, from the Mouse_StatusCodes_t enum
 */
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);
}

/** Task to manage HID report generation and transmission to the host, when in report mode. */
TASK(USB_Mouse_Report)
{
377
378
	/* Check if the USB system is connected to a host */
	if (USB_IsConnected)
379
	{
380
381
		/* Send the next mouse report to the host */
		SendNextReport();
382
	}
383
384
}

385
#if defined(INTERRUPT_CONTROL_ENDPOINT)
386
387
388
389
390
391
392
393
/** 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)
{
394
395
396
	/* Save previously selected endpoint before selecting a new endpoint */
	uint8_t PrevSelectedEndpoint = Endpoint_GetCurrentEndpoint();

397
398
399
400
401
402
403
404
405
	/* 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);
	}
406

407
408
	/* Restore previously selected endpoint */
	Endpoint_SelectEndpoint(PrevSelectedEndpoint);
409
}
410
#endif