mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-10-30 21:02:32 +01:00 
			
		
		
		
	 e071f3897a
			
		
	
	
		e071f3897a
		
	
	
	
	
		
			
			Added new Endpoint_ClearStatusStage() convenience function to assist with the status stages of control transfers. Removed vague USB_IsConnected global - test USB_DeviceState or USB_HostState explicitly to gain previous functionality. Removed USB_IsSuspended global - test USB_DeviceState against DEVICE_STATE_Suspended instead. Fixed possible enumeration errors from spinloops which may fail to exit if the USB connection is severed before the exit condition becomes true.
		
			
				
	
	
		
			325 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			325 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|              LUFA Library
 | |
|      Copyright (C) Dean Camera, 2009.
 | |
|               
 | |
|   dean [at] fourwalledcubicle [dot] com
 | |
|       www.fourwalledcubicle.com
 | |
| */
 | |
| 
 | |
| /*
 | |
|   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 | |
|   Copyright 2009  Denver Gingerich (denver [at] ossguy [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 KeyboardMouse demo. This file contains the main tasks of the demo and
 | |
|  *  is responsible for the initial application hardware configuration.
 | |
|  */
 | |
|  
 | |
| #include "KeyboardMouse.h"
 | |
| 
 | |
| /* Global Variables */
 | |
| /** Global structure to hold the current keyboard interface HID report, for transmission to the host */
 | |
| USB_KeyboardReport_Data_t KeyboardReportData;
 | |
| 
 | |
| /** Global structure to hold the current mouse interface HID report, for transmission to the host */
 | |
| USB_MouseReport_Data_t    MouseReportData;
 | |
| 
 | |
| /** Main program entry point. This routine configures the hardware required by the application, then
 | |
|  *  starts the scheduler to run the USB management task.
 | |
|  */
 | |
| int main(void)
 | |
| {
 | |
| 	SetupHardware();
 | |
| 	
 | |
| 	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 | |
| 
 | |
| 	for (;;)
 | |
| 	{
 | |
| 		Keyboard_HID_Task();
 | |
| 		Mouse_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();
 | |
| }
 | |
| 
 | |
| /** 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_Connect(void)
 | |
| {
 | |
| 	/* Indicate USB enumerating */
 | |
| 	LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 | |
| }
 | |
| 
 | |
| /** 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 task.
 | |
|  */
 | |
| void EVENT_USB_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 and mouse device endpoints.
 | |
|  */
 | |
| void EVENT_USB_ConfigurationChanged(void)
 | |
| {
 | |
| 	/* Indicate USB connected and ready */
 | |
| 	LEDs_SetAllLEDs(LEDMASK_USB_READY);
 | |
| 
 | |
| 	/* Setup Keyboard Report Endpoint */
 | |
| 	if (!(Endpoint_ConfigureEndpoint(KEYBOARD_IN_EPNUM, EP_TYPE_INTERRUPT,
 | |
| 		                             ENDPOINT_DIR_IN, HID_EPSIZE,
 | |
| 	                                 ENDPOINT_BANK_SINGLE)))
 | |
| 	{
 | |
| 		LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 | |
| 	}
 | |
| 	
 | |
| 	/* Setup Keyboard LED Report Endpoint */
 | |
| 	if (!(Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT,
 | |
| 		                             ENDPOINT_DIR_OUT, HID_EPSIZE,
 | |
| 	                                 ENDPOINT_BANK_SINGLE)))
 | |
| 	{
 | |
| 		LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 | |
| 	}
 | |
| 
 | |
| 	/* Setup Mouse Report Endpoint */
 | |
| 	if (!(Endpoint_ConfigureEndpoint(MOUSE_IN_EPNUM, EP_TYPE_INTERRUPT,
 | |
| 		                             ENDPOINT_DIR_IN, HID_EPSIZE,
 | |
| 	                                 ENDPOINT_BANK_SINGLE)))
 | |
| 	{
 | |
| 		LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 | |
| 	}
 | |
| }
 | |
| 
 | |
| /** 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.
 | |
|  */
 | |
| void EVENT_USB_UnhandledControlPacket(void)
 | |
| {
 | |
| 	uint8_t* ReportData;
 | |
| 	uint8_t  ReportSize;
 | |
| 
 | |
| 	/* Handle HID Class specific requests */
 | |
| 	switch (USB_ControlRequest.bRequest)
 | |
| 	{
 | |
| 		case REQ_GetReport:
 | |
| 			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 | |
| 			{
 | |
| 				Endpoint_ClearSETUP();
 | |
| 	
 | |
| 				/* Determine if it is the mouse or the keyboard data that is being requested */
 | |
| 				if (!(USB_ControlRequest.wIndex))
 | |
| 				{
 | |
| 					ReportData = (uint8_t*)&KeyboardReportData;
 | |
| 					ReportSize = sizeof(KeyboardReportData);
 | |
| 				}
 | |
| 				else
 | |
| 				{
 | |
| 					ReportData = (uint8_t*)&MouseReportData;
 | |
| 					ReportSize = sizeof(MouseReportData);
 | |
| 				}
 | |
| 
 | |
| 				/* Write the report data to the control endpoint */
 | |
| 				Endpoint_Write_Control_Stream_LE(ReportData, ReportSize);
 | |
| 
 | |
| 				/* Clear the report data afterwards */
 | |
| 				memset(ReportData, 0, ReportSize);
 | |
| 				
 | |
| 				/* Finalize the stream transfer to send the last packet or clear the host abort */
 | |
| 				Endpoint_ClearOUT();
 | |
| 			}
 | |
| 		
 | |
| 			break;
 | |
| 		case REQ_SetReport:
 | |
| 			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 | |
| 			{
 | |
| 				Endpoint_ClearSETUP();
 | |
| 				
 | |
| 				/* 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 */
 | |
| 				uint8_t LEDStatus = Endpoint_Read_Byte();
 | |
| 				uint8_t LEDMask   = LEDS_LED2;
 | |
| 				
 | |
| 				if (LEDStatus & 0x01) // NUM Lock
 | |
| 				  LEDMask |= LEDS_LED1;
 | |
| 				
 | |
| 				if (LEDStatus & 0x02) // CAPS Lock
 | |
| 				  LEDMask |= LEDS_LED3;
 | |
| 
 | |
| 				if (LEDStatus & 0x04) // SCROLL Lock
 | |
| 				  LEDMask |= LEDS_LED4;
 | |
| 
 | |
| 				/* Set the status LEDs to the current HID LED status */
 | |
| 				LEDs_SetAllLEDs(LEDMask);
 | |
| 
 | |
| 				/* Clear the endpoint data */
 | |
| 				Endpoint_ClearOUT();
 | |
| 
 | |
| 				Endpoint_ClearStatusStage();
 | |
| 			}
 | |
| 			
 | |
| 			break;
 | |
| 	}
 | |
| }
 | |
| 
 | |
| /** Keyboard task. This generates the next keyboard HID report for the host, and transmits it via the
 | |
|  *  keyboard IN endpoint when the host is ready for more data. Additionally, it processes host LED status
 | |
|  *  reports sent to the device via the keyboard OUT reporting endpoint.
 | |
|  */
 | |
| void Keyboard_HID_Task(void)
 | |
| {
 | |
| 	uint8_t JoyStatus_LCL = Joystick_GetStatus();
 | |
| 
 | |
| 	/* Device must be connected and configured for the task to run */
 | |
| 	if (USB_DeviceState != DEVICE_STATE_Configured)
 | |
| 	  return;
 | |
| 
 | |
| 	/* Check if board button is not pressed, if so mouse mode enabled */
 | |
| 	if (!(Buttons_GetStatus() & BUTTONS_BUTTON1))
 | |
| 	{
 | |
| 		if (JoyStatus_LCL & JOY_UP)
 | |
| 		  KeyboardReportData.KeyCode[0] = 0x04; // A
 | |
| 		else if (JoyStatus_LCL & JOY_DOWN)
 | |
| 		  KeyboardReportData.KeyCode[0] = 0x05; // B
 | |
| 
 | |
| 		if (JoyStatus_LCL & JOY_LEFT)
 | |
| 		  KeyboardReportData.KeyCode[0] = 0x06; // C
 | |
| 		else if (JoyStatus_LCL & JOY_RIGHT)
 | |
| 		  KeyboardReportData.KeyCode[0] = 0x07; // D
 | |
| 
 | |
| 		if (JoyStatus_LCL & JOY_PRESS)
 | |
| 		  KeyboardReportData.KeyCode[0] = 0x08; // E
 | |
| 	}
 | |
| 
 | |
| 	/* Select the Keyboard Report Endpoint */
 | |
| 	Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);
 | |
| 
 | |
| 	/* Check if Keyboard Endpoint Ready for Read/Write */
 | |
| 	if (Endpoint_IsReadWriteAllowed())
 | |
| 	{
 | |
| 		/* Write Keyboard Report Data */
 | |
| 		Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
 | |
| 
 | |
| 		/* Finalize the stream transfer to send the last packet */
 | |
| 		Endpoint_ClearIN();
 | |
| 
 | |
| 		/* Clear the report data afterwards */
 | |
| 		memset(&KeyboardReportData, 0, sizeof(KeyboardReportData));
 | |
| 	}
 | |
| 
 | |
| 	/* Select the Keyboard LED Report Endpoint */
 | |
| 	Endpoint_SelectEndpoint(KEYBOARD_OUT_EPNUM);
 | |
| 
 | |
| 	/* Check if Keyboard LED Endpoint Ready for Read/Write */
 | |
| 	if (Endpoint_IsReadWriteAllowed())
 | |
| 	{		
 | |
| 		/* Read in the LED report from the host */
 | |
| 		uint8_t LEDStatus = Endpoint_Read_Byte();
 | |
| 		uint8_t LEDMask   = LEDS_LED2;
 | |
| 		
 | |
| 		if (LEDStatus & 0x01) // NUM Lock
 | |
| 		  LEDMask |= LEDS_LED1;
 | |
| 		
 | |
| 		if (LEDStatus & 0x02) // CAPS Lock
 | |
| 		  LEDMask |= LEDS_LED3;
 | |
| 
 | |
| 		if (LEDStatus & 0x04) // SCROLL Lock
 | |
| 		  LEDMask |= LEDS_LED4;
 | |
| 
 | |
| 		/* Set the status LEDs to the current Keyboard LED status */
 | |
| 		LEDs_SetAllLEDs(LEDMask);
 | |
| 
 | |
| 		/* Handshake the OUT Endpoint - clear endpoint and ready for next report */
 | |
| 		Endpoint_ClearOUT();
 | |
| 	}
 | |
| }
 | |
| 
 | |
| /** Mouse task. This generates the next mouse HID report for the host, and transmits it via the
 | |
|  *  mouse IN endpoint when the host is ready for more data.
 | |
|  */
 | |
| void Mouse_HID_Task(void)
 | |
| {
 | |
| 	uint8_t JoyStatus_LCL = Joystick_GetStatus();
 | |
| 
 | |
| 	/* Device must be connected and configured for the task to run */
 | |
| 	if (USB_DeviceState != DEVICE_STATE_Configured)
 | |
| 	  return;
 | |
| 
 | |
| 	/* Check if board button is pressed, if so mouse mode enabled */
 | |
| 	if (Buttons_GetStatus() & BUTTONS_BUTTON1)
 | |
| 	{
 | |
| 		if (JoyStatus_LCL & JOY_UP)
 | |
| 		  MouseReportData.Y =  1;
 | |
| 		else if (JoyStatus_LCL & JOY_DOWN)
 | |
| 		  MouseReportData.Y = -1;
 | |
| 
 | |
| 		if (JoyStatus_LCL & JOY_RIGHT)
 | |
| 		  MouseReportData.X =  1;
 | |
| 		else if (JoyStatus_LCL & JOY_LEFT)
 | |
| 		  MouseReportData.X = -1;
 | |
| 
 | |
| 		if (JoyStatus_LCL & JOY_PRESS)
 | |
| 		  MouseReportData.Button  = (1 << 0);
 | |
| 	}
 | |
| 
 | |
| 	/* Select the Mouse Report Endpoint */
 | |
| 	Endpoint_SelectEndpoint(MOUSE_IN_EPNUM);
 | |
| 
 | |
| 	/* Check if Mouse Endpoint Ready for Read/Write */
 | |
| 	if (Endpoint_IsReadWriteAllowed())
 | |
| 	{
 | |
| 		/* Write Mouse Report Data */
 | |
| 		Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData));
 | |
| 
 | |
| 		/* Finalize the stream transfer to send the last packet */
 | |
| 		Endpoint_ClearIN();
 | |
| 
 | |
| 		/* Clear the report data afterwards */
 | |
| 		memset(&MouseReportData, 0, sizeof(MouseReportData));
 | |
| 	}
 | |
| }
 |