X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/37b2130fb2767a39f3d95414c6aca75a67c26298..dc42c5eb6b663b0b117b5660ba5818186744efd5:/Demos/Device/KeyboardMouse/KeyboardMouse.c diff --git a/Demos/Device/KeyboardMouse/KeyboardMouse.c b/Demos/Device/KeyboardMouse/KeyboardMouse.c index 957b9b38c..e68a24793 100644 --- a/Demos/Device/KeyboardMouse/KeyboardMouse.c +++ b/Demos/Device/KeyboardMouse/KeyboardMouse.c @@ -31,32 +31,70 @@ /** \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. + * 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" -/* Scheduler Task List */ -TASK_LIST -{ - { .Task = USB_USBTask , .TaskStatus = TASK_STOP }, - { .Task = USB_Mouse , .TaskStatus = TASK_RUN }, - { .Task = USB_Keyboard , .TaskStatus = TASK_RUN }, -}; +/** LUFA HID Class driver interface configuration and state information. This structure is + * passed to all HID Class driver functions, so that multiple instances of the same class + * within a device can be differentiated from one another. This is for the keyboard HID + * interface within the device. + */ +USB_ClassInfo_HID_t Keyboard_HID_Interface = + { + .InterfaceNumber = 0, + + .ReportINEndpointNumber = KEYBOARD_IN_EPNUM, + .ReportINEndpointSize = HID_EPSIZE, + + .ReportOUTEndpointNumber = KEYBOARD_OUT_EPNUM, + .ReportOUTEndpointSize = HID_EPSIZE, + + .ReportINBufferSize = sizeof(USB_KeyboardReport_Data_t), + + .IdleCount = 500, + }; + +/** LUFA HID Class driver interface configuration and state information. This structure is + * passed to all HID Class driver functions, so that multiple instances of the same class + * within a device can be differentiated from one another. This is for the mouse HID + * interface within the device. + */ +USB_ClassInfo_HID_t Mouse_HID_Interface = + { + .InterfaceNumber = 0, + + .ReportINEndpointNumber = MOUSE_IN_EPNUM, + .ReportINEndpointSize = HID_EPSIZE, -/* Global Variables */ -/** Global structure to hold the current keyboard interface HID report, for transmission to the host */ -USB_KeyboardReport_Data_t KeyboardReportData; + .ReportINBufferSize = sizeof(USB_MouseReport_Data_t), -/** Global structure to hold the current mouse interface HID report, for transmission to the host */ -USB_MouseReport_Data_t MouseReportData; + .ReportOUTEndpointNumber = 0, + .ReportOUTEndpointSize = 0, + }; -/** Main program entry point. This routine configures the hardware required by the application, then - * starts the scheduler to run the USB management task. +/** Main program entry point. This routine contains the overall program flow, including initial + * setup of all components and the main program loop. */ int main(void) { + SetupHardware(); + + LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); + + for (;;) + { + USB_HID_USBTask(&Keyboard_HID_Interface); + USB_HID_USBTask(&Mouse_HID_Interface); + USB_USBTask(); + } +} + +/** Configures the board hardware and chip peripherals for the demo's functionality. */ +void SetupHardware() +{ /* Disable watchdog if enabled by bootloader/fuses */ MCUSR &= ~(1 << WDRF); wdt_disable(); @@ -67,295 +105,138 @@ int main(void) /* Hardware Initialization */ Joystick_Init(); LEDs_Init(); - - /* 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(); + + /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */ + OCR0A = ((F_CPU / 64) / 1000); + TCCR0A = (1 << WGM01); + TCCR0B = ((1 << CS01) | (1 << CS00)); + TIMSK0 = (1 << OCIE0A); } -/** 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) +/** Event handler for the library USB Connection event. */ +void EVENT_USB_Connect(void) { - /* Start USB management task */ - Scheduler_SetTaskMode(USB_USBTask, TASK_RUN); + LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); +} - /* Indicate USB enumerating */ - UpdateStatus(Status_USBEnumerating); +/** Event handler for the library USB Disconnection event. */ +void EVENT_USB_Disconnect(void) +{ + LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); } -/** 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. - */ -EVENT_HANDLER(USB_Disconnect) +/** Event handler for the library USB Configuration Changed event. */ +void EVENT_USB_ConfigurationChanged(void) { - /* Stop running HID reporting and USB management tasks */ - Scheduler_SetTaskMode(USB_USBTask, TASK_STOP); + LEDs_SetAllLEDs(LEDMASK_USB_READY); - /* Indicate USB not ready */ - UpdateStatus(Status_USBNotReady); + if (!(USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface))) + LEDs_SetAllLEDs(LEDMASK_USB_ERROR); + + if (!(USB_HID_ConfigureEndpoints(&Mouse_HID_Interface))) + LEDs_SetAllLEDs(LEDMASK_USB_ERROR); } -/** 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. - */ -EVENT_HANDLER(USB_ConfigurationChanged) +/** Event handler for the library USB Unhandled Control Packet event. */ +void EVENT_USB_UnhandledControlPacket(void) { - /* Setup Keyboard Report Endpoint */ - Endpoint_ConfigureEndpoint(KEYBOARD_IN_EPNUM, EP_TYPE_INTERRUPT, - ENDPOINT_DIR_IN, HID_EPSIZE, - ENDPOINT_BANK_SINGLE); - - /* Setup Keyboard LED Report Endpoint */ - Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT, - ENDPOINT_DIR_OUT, HID_EPSIZE, - ENDPOINT_BANK_SINGLE); - - /* Setup Mouse Report Endpoint */ - Endpoint_ConfigureEndpoint(MOUSE_IN_EPNUM, EP_TYPE_INTERRUPT, - ENDPOINT_DIR_IN, HID_EPSIZE, - ENDPOINT_BANK_SINGLE); - - /* Indicate USB connected and ready */ - UpdateStatus(Status_USBReady); + USB_HID_ProcessControlPacket(&Keyboard_HID_Interface); + USB_HID_ProcessControlPacket(&Mouse_HID_Interface); } -/** 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) +/** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */ +ISR(TIMER0_COMPA_vect, ISR_BLOCK) { - uint8_t* ReportData; - uint8_t ReportSize; + if (Keyboard_HID_Interface.IdleMSRemaining) + Keyboard_HID_Interface.IdleMSRemaining--; - /* Handle HID Class specific requests */ - switch (bRequest) - { - case REQ_GetReport: - if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE)) - { - Endpoint_Discard_Word(); - - uint16_t wIndex = Endpoint_Read_Word_LE(); - - /* Determine if it is the mouse or the keyboard data that is being requested */ - if (!(wIndex)) - { - ReportData = (uint8_t*)&KeyboardReportData; - ReportSize = sizeof(KeyboardReportData); - } - else - { - ReportData = (uint8_t*)&MouseReportData; - ReportSize = sizeof(MouseReportData); - } - - /* Read in the number of bytes in the report to send to the host */ - uint16_t wLength = Endpoint_Read_Word_LE(); - - /* If trying to send more bytes than exist to the host, clamp the value at the report size */ - if (wLength > ReportSize) - wLength = ReportSize; - - Endpoint_ClearControlSETUP(); - - /* Write the report data to the control endpoint */ - Endpoint_Write_Control_Stream_LE(ReportData, wLength); - - /* Clear the report data afterwards */ - memset(ReportData, 0, ReportSize); - - /* Finalize the stream transfer to send the last packet or clear the host abort */ - Endpoint_ClearControlOUT(); - } - - break; - case REQ_SetReport: - if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE)) - { - Endpoint_ClearControlSETUP(); - - /* 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(); - 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_ClearControlOUT(); - - /* Acknowledge status stage */ - while (!(Endpoint_IsINReady())); - Endpoint_ClearControlIN(); - } - - break; - } + if (Mouse_HID_Interface.IdleMSRemaining) + Mouse_HID_Interface.IdleMSRemaining--; } -/** 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. +/** HID class driver callback function for the creation of HID reports to the host. * - * \param CurrentStatus Current status of the system, from the KeyboardMouse_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); -} - -/** 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. + * \param HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced + * \param ReportData Pointer to a buffer where the created report should be stored + * + * \return Number of bytes written in the report (or zero if no report is to be sent */ -TASK(USB_Keyboard) +uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData) { - uint8_t JoyStatus_LCL = Joystick_GetStatus(); + uint8_t JoyStatus_LCL = Joystick_GetStatus(); + uint8_t ButtonStatus_LCL = Buttons_GetStatus(); - /* Check if HWB is not pressed, if so mouse mode enabled */ - if (!(HWB_GetStatus())) + if (HIDInterfaceInfo == &Keyboard_HID_Interface) { + USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData; + + /* If first board button not being held down, no keyboard report */ + if (!(ButtonStatus_LCL & BUTTONS_BUTTON1)) + return 0; + if (JoyStatus_LCL & JOY_UP) - KeyboardReportData.KeyCode[0] = 0x04; // A + KeyboardReport->KeyCode[0] = 0x04; // A else if (JoyStatus_LCL & JOY_DOWN) - KeyboardReportData.KeyCode[0] = 0x05; // B + KeyboardReport->KeyCode[0] = 0x05; // B if (JoyStatus_LCL & JOY_LEFT) - KeyboardReportData.KeyCode[0] = 0x06; // C + KeyboardReport->KeyCode[0] = 0x06; // C else if (JoyStatus_LCL & JOY_RIGHT) - KeyboardReportData.KeyCode[0] = 0x07; // D + KeyboardReport->KeyCode[0] = 0x07; // D if (JoyStatus_LCL & JOY_PRESS) - KeyboardReportData.KeyCode[0] = 0x08; // E + KeyboardReport->KeyCode[0] = 0x08; // E + + return sizeof(USB_KeyboardReport_Data_t); } - - /* Check if the USB system is connected to a host and report protocol mode is enabled */ - if (USB_IsConnected) + else { - /* 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. - */ -TASK(USB_Mouse) -{ - uint8_t JoyStatus_LCL = Joystick_GetStatus(); + USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData; - /* Check if HWB is pressed, if so mouse mode enabled */ - if (HWB_GetStatus()) - { + /* If first board button being held down, no mouse report */ + if (ButtonStatus_LCL & BUTTONS_BUTTON1) + return 0; + if (JoyStatus_LCL & JOY_UP) - MouseReportData.Y = 1; + MouseReport->Y = -1; else if (JoyStatus_LCL & JOY_DOWN) - MouseReportData.Y = -1; + MouseReport->Y = 1; if (JoyStatus_LCL & JOY_RIGHT) - MouseReportData.X = 1; + MouseReport->X = 1; else if (JoyStatus_LCL & JOY_LEFT) - MouseReportData.X = -1; + MouseReport->X = -1; if (JoyStatus_LCL & JOY_PRESS) - MouseReportData.Button = (1 << 0); + MouseReport->Button = (1 << 0); + + return sizeof(USB_MouseReport_Data_t); } +} - /* Check if the USB system is connected to a host and report protocol mode is enabled */ - if (USB_IsConnected) +/** HID class driver callback function for the processing of HID reports from the host. + * + * \param HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced + * \param ReportData Pointer to a buffer where the created report has been stored + * \param ReportSize Size in bytes of the received HID report + */ +void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize) +{ + if (HIDInterfaceInfo == &Keyboard_HID_Interface) { - /* Select the Mouse Report Endpoint */ - Endpoint_SelectEndpoint(MOUSE_IN_EPNUM); + uint8_t LEDMask = LEDS_NO_LEDS; + uint8_t* LEDReport = (uint8_t*)ReportData; - /* 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(); + if (*LEDReport & 0x01) // NUM Lock + LEDMask |= LEDS_LED1; + + if (*LEDReport & 0x02) // CAPS Lock + LEDMask |= LEDS_LED3; - /* Clear the report data afterwards */ - memset(&MouseReportData, 0, sizeof(MouseReportData)); - } + if (*LEDReport & 0x04) // SCROLL Lock + LEDMask |= LEDS_LED4; + + LEDs_SetAllLEDs(LEDMask); } -} +} \ No newline at end of file