+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2009 Denver Gingerich (denver [at] ossguy [dot] com)\r
- Based on code by Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, and distribute this software\r
- and its documentation for any purpose and without fee is hereby\r
- granted, provided that the above copyright notice appear in all\r
- copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting\r
- documentation, and that the name of the author not be used in\r
- advertising or publicity pertaining to distribution of the\r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * Main source file for the KeyboardFullInt demo. This file contains the main tasks of the demo and\r
- * is responsible for the initial application hardware configuration.\r
- */\r
- \r
-#include "Keyboard.h"\r
-\r
-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName, "LUFA Keyboard App");\r
-BUTTLOADTAG(BuildTime, __TIME__);\r
-BUTTLOADTAG(BuildDate, __DATE__);\r
-BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
-\r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
- #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
- { Task: USB_USBTask , TaskStatus: TASK_STOP },\r
- #endif\r
- \r
- #if !defined(INTERRUPT_DATA_ENDPOINT)\r
- { Task: USB_Keyboard_Report , TaskStatus: TASK_STOP },\r
- #endif\r
-};\r
-\r
-/* Global Variables */\r
-/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot\r
- * protocol reporting mode.\r
- */\r
-bool UsingReportProtocol = true;\r
-\r
-/** Current Idle period. This is set by the host via a Set Idle HID class request to silence the device's reports\r
- * for either the entire idle duration, or until the report status changes (e.g. the user moves the mouse).\r
- */\r
-uint8_t IdleCount = 0;\r
-\r
-/** Current Idle period remaining. When the IdleCount value is set, this tracks the remaining number of idle\r
- * milliseconds. This is seperate to the IdleCount timer and is incremented and compared as the host may request \r
- * the current idle period via a Get Idle HID class request, thus its value must be preserved.\r
- */\r
-uint16_t IdleMSRemaining = 0;\r
-\r
-\r
-/** Main program entry point. This routine configures the hardware required by the application, then\r
- * starts the scheduler to run the USB management task.\r
- */\r
-int main(void)\r
-{\r
- /* Disable watchdog if enabled by bootloader/fuses */\r
- MCUSR &= ~(1 << WDRF);\r
- wdt_disable();\r
-\r
- /* Disable clock division */\r
- clock_prescale_set(clock_div_1);\r
-\r
- /* Hardware Initialization */\r
- Joystick_Init();\r
- LEDs_Init();\r
- \r
- /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */\r
- OCR0A = 0x7D;\r
- TCCR0A = (1 << WGM01);\r
- TCCR0B = ((1 << CS01) | (1 << CS00));\r
- TIMSK0 = (1 << OCIE0A);\r
-\r
- /* Indicate USB not ready */\r
- UpdateStatus(Status_USBNotReady);\r
-\r
- /* Initialize Scheduler so that it can be used */\r
- Scheduler_Init();\r
-\r
- /* Initialize USB Subsystem */\r
- USB_Init();\r
- \r
- /* Scheduling - routine never returns, so put this last in the main function */\r
- Scheduler_Start();\r
-}\r
-\r
-/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
- * starts the library USB task to begin the enumeration and USB management process.\r
- */\r
-EVENT_HANDLER(USB_Connect)\r
-{\r
- #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
- /* Start USB management task */\r
- Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
- #endif\r
-\r
- /* Indicate USB enumerating */\r
- UpdateStatus(Status_USBEnumerating);\r
-\r
- /* Default to report protocol on connect */\r
- UsingReportProtocol = true;\r
-}\r
-\r
-/** Event handler for the USB_Reset event. This fires when the USB interface is reset by the USB host, before the\r
- * enumeration process begins, and enables the control endpoint interrupt so that control requests can be handled\r
- * asynchronously when they arrive rather than when the control endpoint is polled manually.\r
- */\r
-EVENT_HANDLER(USB_Reset)\r
-{\r
- #if defined(INTERRUPT_CONTROL_ENDPOINT)\r
- /* Select the control endpoint */\r
- Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);\r
-\r
- /* Enable the endpoint SETUP interrupt ISR for the control endpoint */\r
- USB_INT_Enable(ENDPOINT_INT_SETUP);\r
- #endif\r
-}\r
-\r
-/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
- * the status LEDs.\r
- */\r
-EVENT_HANDLER(USB_Disconnect)\r
-{\r
- /* Stop running keyboard reporting and USB management tasks */\r
- #if !defined(INTERRUPT_DATA_ENDPOINT)\r
- Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_STOP);\r
- #endif\r
-\r
- #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
- Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
- #endif\r
- \r
- /* Indicate USB not ready */\r
- UpdateStatus(Status_USBNotReady);\r
-}\r
-\r
-/** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration\r
- * of the USB device after enumeration, and configures the keyboard device endpoints.\r
- */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
-{\r
- /* Setup Keyboard Keycode Report Endpoint */\r
- Endpoint_ConfigureEndpoint(KEYBOARD_EPNUM, EP_TYPE_INTERRUPT,\r
- ENDPOINT_DIR_IN, KEYBOARD_EPSIZE,\r
- ENDPOINT_BANK_SINGLE);\r
-\r
- #if defined(INTERRUPT_DATA_ENDPOINT)\r
- /* Enable the endpoint IN interrupt ISR for the report endpoint */\r
- USB_INT_Enable(ENDPOINT_INT_IN);\r
- #endif\r
-\r
- /* Setup Keyboard LED Report Endpoint */\r
- Endpoint_ConfigureEndpoint(KEYBOARD_LEDS_EPNUM, EP_TYPE_INTERRUPT,\r
- ENDPOINT_DIR_OUT, KEYBOARD_EPSIZE,\r
- ENDPOINT_BANK_SINGLE);\r
-\r
- #if defined(INTERRUPT_DATA_ENDPOINT)\r
- /* Enable the endpoint OUT interrupt ISR for the LED report endpoint */\r
- USB_INT_Enable(ENDPOINT_INT_OUT);\r
- #endif\r
-\r
- /* Indicate USB connected and ready */\r
- UpdateStatus(Status_USBReady);\r
-\r
- #if !defined(INTERRUPT_DATA_ENDPOINT)\r
- /* Start running keyboard reporting task */\r
- Scheduler_SetTaskMode(USB_Keyboard_Report, TASK_RUN);\r
- #endif\r
-}\r
-\r
-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
- * control requests that are not handled internally by the USB library (including the HID commands, which are\r
- * all issued via the control endpoint), so that they can be handled appropriately for the application.\r
- */\r
-EVENT_HANDLER(USB_UnhandledControlPacket)\r
-{\r
- /* Handle HID Class specific requests */\r
- switch (bRequest)\r
- {\r
- case REQ_GetReport:\r
- if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- USB_KeyboardReport_Data_t KeyboardReportData;\r
-\r
- /* Create the next keyboard report for transmission to the host */\r
- CreateKeyboardReport(&KeyboardReportData);\r
-\r
- /* Ignore report type and ID number value */\r
- Endpoint_Discard_Word();\r
- \r
- /* Ignore unused Interface number value */\r
- Endpoint_Discard_Word();\r
-\r
- /* Read in the number of bytes in the report to send to the host */\r
- uint16_t wLength = Endpoint_Read_Word_LE();\r
- \r
- /* If trying to send more bytes than exist to the host, clamp the value at the report size */\r
- if (wLength > sizeof(KeyboardReportData))\r
- wLength = sizeof(KeyboardReportData);\r
-\r
- Endpoint_ClearSetupReceived();\r
- \r
- /* Write the report data to the control endpoint */\r
- Endpoint_Write_Control_Stream_LE(&KeyboardReportData, wLength);\r
- \r
- /* Finalize the stream transfer to send the last packet or clear the host abort */\r
- Endpoint_ClearSetupOUT();\r
- }\r
- \r
- break;\r
- case REQ_SetReport:\r
- if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- Endpoint_ClearSetupReceived();\r
- \r
- /* Wait until the LED report has been sent by the host */\r
- while (!(Endpoint_IsSetupOUTReceived()));\r
-\r
- /* Read in the LED report from the host */\r
- uint8_t LEDStatus = Endpoint_Read_Byte();\r
-\r
- /* Process the incomming LED report */\r
- ProcessLEDReport(LEDStatus);\r
- \r
- /* Clear the endpoint data */\r
- Endpoint_ClearSetupOUT();\r
-\r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsSetupINReady()));\r
- Endpoint_ClearSetupIN();\r
- }\r
- \r
- break;\r
- case REQ_GetProtocol:\r
- if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- Endpoint_ClearSetupReceived();\r
- \r
- /* Write the current protocol flag to the host */\r
- Endpoint_Write_Byte(UsingReportProtocol);\r
- \r
- /* Send the flag to the host */\r
- Endpoint_ClearSetupIN();\r
-\r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsSetupOUTReceived()));\r
- Endpoint_ClearSetupOUT();\r
- }\r
- \r
- break;\r
- case REQ_SetProtocol:\r
- if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- /* Read in the wValue parameter containing the new protocol mode */\r
- uint16_t wValue = Endpoint_Read_Word_LE();\r
- \r
- Endpoint_ClearSetupReceived();\r
-\r
- /* Set or clear the flag depending on what the host indicates that the current Protocol should be */\r
- UsingReportProtocol = (wValue != 0x0000);\r
-\r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsSetupINReady()));\r
- Endpoint_ClearSetupIN();\r
- }\r
- \r
- break;\r
- case REQ_SetIdle:\r
- if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
- {\r
- /* Read in the wValue parameter containing the idle period */\r
- uint16_t wValue = Endpoint_Read_Word_LE();\r
- \r
- Endpoint_ClearSetupReceived();\r
- \r
- /* Get idle period in MSB */\r
- IdleCount = (wValue >> 8);\r
- \r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsSetupINReady()));\r
- Endpoint_ClearSetupIN();\r
- }\r
- \r
- break;\r
- case REQ_GetIdle:\r
- if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
- { \r
- Endpoint_ClearSetupReceived();\r
- \r
- /* Write the current idle duration to the host */\r
- Endpoint_Write_Byte(IdleCount);\r
- \r
- /* Send the flag to the host */\r
- Endpoint_ClearSetupIN();\r
-\r
- /* Acknowledge status stage */\r
- while (!(Endpoint_IsSetupOUTReceived()));\r
- Endpoint_ClearSetupOUT();\r
- }\r
-\r
- break;\r
- }\r
-}\r
-\r
-/** ISR for the timer 0 compare vector. This ISR fires once each millisecond, and increments the\r
- * scheduler elapsed idle period counter when the host has set an idle period.\r
- */\r
-ISR(TIMER0_COMPA_vect, ISR_BLOCK)\r
-{\r
- /* One millisecond has elapsed, decrement the idle time remaining counter if it has not already elapsed */\r
- if (IdleMSRemaining)\r
- IdleMSRemaining--;\r
-}\r
-\r
-/** Fills the given HID report data structure with the next HID report to send to the host.\r
- *\r
- * \param ReportData Pointer to a HID report data structure to be filled\r
- */\r
-void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData)\r
-{\r
- uint8_t JoyStatus_LCL = Joystick_GetStatus();\r
-\r
- /* Clear the report contents */\r
- memset(ReportData, 0, sizeof(USB_KeyboardReport_Data_t));\r
-\r
- if (JoyStatus_LCL & JOY_UP)\r
- ReportData->KeyCode[0] = 0x04; // A\r
- else if (JoyStatus_LCL & JOY_DOWN)\r
- ReportData->KeyCode[0] = 0x05; // B\r
-\r
- if (JoyStatus_LCL & JOY_LEFT)\r
- ReportData->KeyCode[0] = 0x06; // C\r
- else if (JoyStatus_LCL & JOY_RIGHT)\r
- ReportData->KeyCode[0] = 0x07; // D\r
-\r
- if (JoyStatus_LCL & JOY_PRESS)\r
- ReportData->KeyCode[0] = 0x08; // E\r
-}\r
-\r
-/** Processes a received LED report, and updates the board LEDs states to match.\r
- *\r
- * \param LEDReport LED status report from the host\r
- */\r
-void ProcessLEDReport(uint8_t LEDReport)\r
-{\r
- uint8_t LEDMask = LEDS_LED2;\r
- \r
- if (LEDReport & 0x01) // NUM Lock\r
- LEDMask |= LEDS_LED1;\r
- \r
- if (LEDReport & 0x02) // CAPS Lock\r
- LEDMask |= LEDS_LED3;\r
-\r
- if (LEDReport & 0x04) // SCROLL Lock\r
- LEDMask |= LEDS_LED4;\r
-\r
- /* Set the status LEDs to the current Keyboard LED status */\r
- LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-/** Sends the next HID report to the host, via the keyboard data endpoint. */\r
-static inline void SendNextReport(void)\r
-{\r
- static USB_KeyboardReport_Data_t PrevKeyboardReportData;\r
- USB_KeyboardReport_Data_t KeyboardReportData;\r
- bool SendReport = true;\r
- \r
- /* Create the next keyboard report for transmission to the host */\r
- CreateKeyboardReport(&KeyboardReportData);\r
- \r
- /* Check if the idle period is set */\r
- if (IdleCount)\r
- {\r
- /* Check if idle period has elapsed */\r
- if (!(IdleMSRemaining))\r
- {\r
- /* Reset the idle time remaining counter, must multiply by 4 to get the duration in milliseconds */\r
- IdleMSRemaining = (IdleCount << 2);\r
- }\r
- else\r
- {\r
- /* Idle period not elapsed, indicate that a report must not be sent unless the report has changed */\r
- SendReport = (memcmp(&PrevKeyboardReportData, &KeyboardReportData, sizeof(USB_KeyboardReport_Data_t)) != 0);\r
- }\r
- }\r
- \r
- /* Save the current report data for later comparison to check for changes */\r
- PrevKeyboardReportData = KeyboardReportData;\r
-\r
- /* Select the Keyboard Report Endpoint */\r
- Endpoint_SelectEndpoint(KEYBOARD_EPNUM);\r
-\r
- /* Check if Keyboard Endpoint Ready for Read/Write, and if we should send a report */\r
- if (Endpoint_ReadWriteAllowed() && SendReport)\r
- {\r
- /* Write Keyboard Report Data */\r
- Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\r
-\r
- /* Finalize the stream transfer to send the last packet */\r
- Endpoint_ClearCurrentBank();\r
- }\r
-}\r
-\r
-/** Reads the next LED status report from the host from the LED data endpoint, if one has been sent. */\r
-static inline void ReceiveNextReport(void)\r
-{\r
- /* Select the Keyboard LED Report Endpoint */\r
- Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r
-\r
- /* Check if Keyboard LED Endpoint Ready for Read/Write */\r
- if (!(Endpoint_ReadWriteAllowed()))\r
- return;\r
-\r
- /* Read in the LED report from the host */\r
- uint8_t LEDReport = Endpoint_Read_Byte();\r
-\r
- /* Handshake the OUT Endpoint - clear endpoint and ready for next report */\r
- Endpoint_ClearCurrentBank();\r
-\r
- /* Process the read LED report from the host */\r
- ProcessLEDReport(LEDReport);\r
-}\r
-\r
-/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
- * log to a serial port, or anything else that is suitable for status updates.\r
- *\r
- * \param CurrentStatus Current status of the system, from the KeyboardFullInt_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
-{\r
- uint8_t LEDMask = LEDS_NO_LEDS;\r
- \r
- /* Set the LED mask to the appropriate LED mask based on the given status code */\r
- switch (CurrentStatus)\r
- {\r
- case Status_USBNotReady:\r
- LEDMask = (LEDS_LED1);\r
- break;\r
- case Status_USBEnumerating:\r
- LEDMask = (LEDS_LED1 | LEDS_LED2);\r
- break;\r
- case Status_USBReady:\r
- LEDMask = (LEDS_LED2 | LEDS_LED4);\r
- break;\r
- }\r
- \r
- /* Set the board LEDs to the new LED mask */\r
- LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-#if !defined(INTERRUPT_DATA_ENDPOINT)\r
-/** Function to manage HID report generation and transmission to the host, when in report mode. */\r
-TASK(USB_Keyboard_Report)\r
-{\r
- /* Check if the USB system is connected to a host */\r
- if (USB_IsConnected)\r
- {\r
- /* Send the next keypress report to the host */\r
- SendNextReport();\r
- \r
- /* Process the LED report sent from the host */\r
- ReceiveNextReport();\r
- }\r
-}\r
-#endif\r
-\r
-/** ISR for the general Pipe/Endpoint interrupt vector. This ISR fires when an endpoint's status changes (such as\r
- * a packet has been received) on an endpoint with its corresponding ISR enabling bits set. This is used to send\r
- * HID packets to the host each time the HID interrupt endpoints polling period elapses, as managed by the USB\r
- * controller. It is also used to respond to standard and class specific requests send to the device on the control\r
- * endpoint, by handing them off to the LUFA library when they are received.\r
- */\r
-ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
-{\r
- #if defined(INTERRUPT_CONTROL_ENDPOINT)\r
- /* Check if the control endpoint has received a request */\r
- if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))\r
- {\r
- /* Clear the endpoint interrupt */\r
- Endpoint_ClearEndpointInterrupt(ENDPOINT_CONTROLEP);\r
-\r
- /* Process the control request */\r
- USB_USBTask();\r
-\r
- /* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */\r
- USB_INT_Clear(ENDPOINT_INT_SETUP);\r
- }\r
- #endif\r
-\r
- #if defined(INTERRUPT_DATA_ENDPOINT)\r
- /* Check if keyboard endpoint has interrupted */\r
- if (Endpoint_HasEndpointInterrupted(KEYBOARD_EPNUM))\r
- {\r
- /* Select the Keyboard Report Endpoint */\r
- Endpoint_SelectEndpoint(KEYBOARD_EPNUM);\r
-\r
- /* Clear the endpoint IN interrupt flag */\r
- USB_INT_Clear(ENDPOINT_INT_IN);\r
-\r
- /* Clear the Keyboard Report endpoint interrupt */\r
- Endpoint_ClearEndpointInterrupt(KEYBOARD_EPNUM);\r
-\r
- /* Send the next keypress report to the host */\r
- SendNextReport();\r
- }\r
-\r
- /* Check if Keyboard LED status Endpoint has interrupted */\r
- if (Endpoint_HasEndpointInterrupted(KEYBOARD_LEDS_EPNUM))\r
- {\r
- /* Select the Keyboard LED Report Endpoint */\r
- Endpoint_SelectEndpoint(KEYBOARD_LEDS_EPNUM);\r
-\r
- /* Clear the endpoint OUT interrupt flag */\r
- USB_INT_Clear(ENDPOINT_INT_OUT);\r
-\r
- /* Clear the Keyboard LED Report endpoint interrupt */\r
- Endpoint_ClearEndpointInterrupt(KEYBOARD_LEDS_EPNUM);\r
-\r
- /* Process the LED report sent from the host */\r
- ReceiveNextReport();\r
- }\r
- #endif\r
-}\r
-\r
projects / pub / lufa.git / blobdiff