X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/2440ca268ac444c1aed2441cefe9e25a767d961a..d1e52660368d34d693131f6aff3c8fd8584162e5:/Demos/Device/Keyboard/Keyboard.c?ds=inline

diff --git a/Demos/Device/Keyboard/Keyboard.c b/Demos/Device/Keyboard/Keyboard.c
index 6abd193f4..d8893bfaa 100644
--- a/Demos/Device/Keyboard/Keyboard.c
+++ b/Demos/Device/Keyboard/Keyboard.c
@@ -28,397 +28,120 @@
   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.
- */
  
 #include "Keyboard.h"
 
-/* Scheduler Task List */
-TASK_LIST
-{
-	{ .Task = USB_USBTask          , .TaskStatus = TASK_STOP },	
-	{ .Task = USB_Keyboard_Report  , .TaskStatus = TASK_STOP },
-};
-
-/* 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;
+USB_ClassInfo_HID_t Keyboard_HID_Interface =
+    {
+        .InterfaceNumber         = 0,
 
-/** 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).
- */
-uint16_t IdleCount = 500;
+        .ReportINEndpointNumber  = KEYBOARD_EPNUM,
+        .ReportINEndpointSize    = KEYBOARD_EPSIZE,
 
-/** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle
- *  milliseconds. This is separate to the IdleCount timer and is incremented and compared as the host may request 
- *  the current idle period via a Get Idle HID class request, thus its value must be preserved.
- */
-uint16_t IdleMSRemaining = 0;
+        .ReportOUTEndpointNumber = KEYBOARD_LEDS_EPNUM,
+        .ReportOUTEndpointSize   = KEYBOARD_EPSIZE,
+        
+		.ReportBufferSize        = sizeof(USB_KeyboardReport_Data_t),
 
+        .IdleCount               = 500,
+    };
 
-/** 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)
 {
-	/* 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();
-	
-	/* 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();
+    SetupHardware();
+
+    LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+    
+    for (;;)
+    {
+        USB_HID_USBTask(&Keyboard_HID_Interface);
+        USB_USBTask();
+    }
+}
 
-	/* Initialize USB Subsystem */
-	USB_Init();
-	
-	/* Scheduling - routine never returns, so put this last in the main function */
-	Scheduler_Start();
+void SetupHardware()
+{
+    /* 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();
+    Buttons_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)
 {
-	/* Start USB management task */
-	Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);
-
-	/* Indicate USB enumerating */
-	UpdateStatus(Status_USBEnumerating);
-
-	/* Default to report protocol on connect */
-	UsingReportProtocol = true;
+    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.
- */
 void EVENT_USB_Disconnect(void)
 {
-	/* Stop running keyboard reporting and USB management tasks */
-	Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);
-	Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);
-	
-	/* Indicate USB not ready */
-	UpdateStatus(Status_USBNotReady);
+    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_ConfigurationChanged(void)
 {
-	/* 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);
+    LEDs_SetAllLEDs(LEDMASK_USB_READY);
 
-	/* Indicate USB connected and ready */
-	UpdateStatus(Status_USBReady);
-
-	/* Start running keyboard reporting task */
-	Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);
+    if (!(USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface)))
+      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)
 {
-	/* Handle HID Class specific requests */
-	switch (USB_ControlRequest.bRequest)
-	{
-		case REQ_GetReport:
-			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
-			{
-				USB_KeyboardReport_Data_t KeyboardReportData;
-
-				Endpoint_ClearSETUP();
-	
-				/* Create the next keyboard report for transmission to the host */
-				CreateKeyboardReport(&KeyboardReportData);
-
-				/* Write the report data to the control endpoint */
-				Endpoint_Write_Control_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
-				
-				/* 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()));
-
-				/* Read in the LED report from the host */
-				uint8_t LEDStatus = Endpoint_Read_Byte();
-
-				/* Process the incoming LED report */
-				ProcessLEDReport(LEDStatus);
-			
-				/* Clear the endpoint data */
-				Endpoint_ClearOUT();
-
-				/* Acknowledge status stage */
-				while (!(Endpoint_IsINReady()));
-				Endpoint_ClearIN();
-			}
-			
-			break;
-		case REQ_GetProtocol:
-			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
-			{
-				Endpoint_ClearSETUP();
-				
-				/* Write the current protocol flag to the host */
-				Endpoint_Write_Byte(UsingReportProtocol);
-				
-				/* Send the flag to the host */
-				Endpoint_ClearIN();
-
-				/* Acknowledge status stage */
-				while (!(Endpoint_IsOUTReceived()));
-				Endpoint_ClearOUT();
-			}
-			
-			break;
-		case REQ_SetProtocol:
-			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
-			{
-				Endpoint_ClearSETUP();
-
-				/* Set or clear the flag depending on what the host indicates that the current Protocol should be */
-				UsingReportProtocol = (USB_ControlRequest.wValue != 0);
-
-				/* Acknowledge status stage */
-				while (!(Endpoint_IsINReady()));
-				Endpoint_ClearIN();
-			}
-			
-			break;
-		case REQ_SetIdle:
-			if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
-			{
-				Endpoint_ClearSETUP();
-				
-				/* Get idle period in MSB */
-				IdleCount = (USB_ControlRequest.wValue >> 8);
-				
-				/* Acknowledge status stage */
-				while (!(Endpoint_IsINReady()));
-				Endpoint_ClearIN();
-			}
-			
-			break;
-		case REQ_GetIdle:
-			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
-			{		
-				Endpoint_ClearSETUP();
-				
-				/* Write the current idle duration to the host */
-				Endpoint_Write_Byte(IdleCount);
-				
-				/* Send the flag to the host */
-				Endpoint_ClearIN();
-
-				/* Acknowledge status stage */
-				while (!(Endpoint_IsOUTReceived()));
-				Endpoint_ClearOUT();
-			}
-
-			break;
-	}
+    USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);
 }
 
-/** 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)
+void EVENT_USB_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 ReportData  Pointer to a HID report data structure to be filled
- */
-void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData)
-{
-	uint8_t JoyStatus_LCL = Joystick_GetStatus();
-
-	/* 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
-}
-
-/** Processes a received LED report, and updates the board LEDs states to match.
- *
- *  \param LEDReport  LED status report from the host
- */
-void ProcessLEDReport(uint8_t LEDReport)
-{
-	uint8_t LEDMask = LEDS_LED2;
-	
-	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);
-}
-
-/** 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;
-	
-	/* Create the next keyboard report for transmission to the host */
-	CreateKeyboardReport(&KeyboardReportData);
-	
-	/* 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);
-	
-	/* Save the current report data for later comparison to check for changes */
-	PrevKeyboardReportData = KeyboardReportData;
-	
-	/* 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;
-	}
-	
-	/* Select the Keyboard Report Endpoint */
-	Endpoint_SelectEndpoint(KEYBOARD_EPNUM);
-
-	/* Check if Keyboard Endpoint Ready for Read/Write and if we should send a new report */
-	if (Endpoint_IsReadWriteAllowed() && SendReport)
-	{
-		/* Write Keyboard Report Data */
-		Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));
-		
-		/* 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 */
-	Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);
-
-	/* 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();
-
-			/* Process the read LED report from the host */
-			ProcessLEDReport(LEDReport);
-		}
-
-		/* Handshake the OUT Endpoint - clear endpoint and ready for next report */
-		Endpoint_ClearOUT();
-	}
+    USB_HID_RegisterStartOfFrame(&Keyboard_HID_Interface);
 }
 
-/** 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 Keyboard_StatusCodes_t enum
- */
-void UpdateStatus(uint8_t CurrentStatus)
+uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)
 {
-	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);
+    USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
+    
+    uint8_t JoyStatus_LCL    = Joystick_GetStatus();
+    uint8_t ButtonStatus_LCL = Buttons_GetStatus();
+
+    if (JoyStatus_LCL & JOY_UP)
+      KeyboardReport->KeyCode[0] = 0x04; // A
+    else if (JoyStatus_LCL & JOY_DOWN)
+      KeyboardReport->KeyCode[0] = 0x05; // B
+
+    if (JoyStatus_LCL & JOY_LEFT)
+      KeyboardReport->KeyCode[0] = 0x06; // C
+    else if (JoyStatus_LCL & JOY_RIGHT)
+      KeyboardReport->KeyCode[0] = 0x07; // D
+
+    if (JoyStatus_LCL & JOY_PRESS)
+      KeyboardReport->KeyCode[0] = 0x08; // E
+      
+    if (ButtonStatus_LCL & BUTTONS_BUTTON1)
+      KeyboardReport->KeyCode[0] = 0x09; // F
+      
+    return sizeof(USB_KeyboardReport_Data_t);
 }
 
-/** Function to manage HID report generation and transmission to the host, when in report mode. */
-TASK(USB_Keyboard_Report)
+void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)
 {
-	/* Check if the USB system is connected to a host */
-	if (USB_IsConnected)
-	{
-		/* Send the next keypress report to the host */
-		SendNextReport();
-		
-		/* Process the LED report sent from the host */
-		ReceiveNextReport();
-	}
+    uint8_t  LEDMask   = LEDS_NO_LEDS;
+    uint8_t* LEDReport = (uint8_t*)ReportData;
+
+    if (*LEDReport & 0x01) // NUM Lock
+      LEDMask |= LEDS_LED1;
+    
+    if (*LEDReport & 0x02) // CAPS Lock
+      LEDMask |= LEDS_LED3;
+
+    if (*LEDReport & 0x04) // SCROLL Lock
+      LEDMask |= LEDS_LED4;
+      
+    LEDs_SetAllLEDs(LEDMask);
 }