Allow the title of top level pages to be overridden in the Atmel Studio help.
[pub/USBasp.git] / Demos / Device / ClassDriver / GenericHID / GenericHID.c
index 5e26580..95dd44d 100644 (file)
-/*\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  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 GenericHID demo. This file contains the main tasks of\r
- *  the demo and is responsible for the initial application hardware configuration.\r
- */\r
-\r
-#include "GenericHID.h"\r
-\r
-/** Buffer to hold the previously generated HID report, for comparison purposes inside the HID class driver. */\r
-uint8_t PrevHIDReportBuffer[GENERIC_REPORT_SIZE];\r
-\r
-/** Structure to contain reports from the host, so that they can be echoed back upon request */\r
-struct\r
-{\r
-       uint8_t  ReportID;\r
-       uint16_t ReportSize;\r
-       uint8_t  ReportData[GENERIC_REPORT_SIZE];\r
-} HIDReportEcho;\r
-\r
-/** LUFA HID Class driver interface configuration and state information. This structure is\r
- *  passed to all HID Class driver functions, so that multiple instances of the same class\r
- *  within a device can be differentiated from one another.\r
- */\r
-USB_ClassInfo_HID_Device_t Generic_HID_Interface =\r
-       {\r
-               .Config =\r
-                       {\r
-                               .InterfaceNumber              = 0,\r
-\r
-                               .ReportINEndpointNumber       = GENERIC_IN_EPNUM,\r
-                               .ReportINEndpointSize         = GENERIC_EPSIZE,\r
-                               .ReportINEndpointDoubleBank   = false,\r
-                               \r
-                               .PrevReportINBuffer           = PrevHIDReportBuffer,\r
-                               .PrevReportINBufferSize       = sizeof(PrevHIDReportBuffer),\r
-                       },\r
-       };\r
-\r
-/** Main program entry point. This routine contains the overall program flow, including initial\r
- *  setup of all components and the main program loop.\r
- */\r
-int main(void)\r
-{\r
-       SetupHardware();\r
-       \r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-       \r
-       for (;;)\r
-       {\r
-               HID_Device_USBTask(&Generic_HID_Interface);\r
-               USB_USBTask();\r
-       }\r
-}\r
-\r
-/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
-void SetupHardware(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
-       LEDs_Init();\r
-       USB_Init();\r
-}\r
-\r
-/** Event handler for the library USB Connection event. */\r
-void EVENT_USB_Device_Connect(void)\r
-{\r
-       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);       \r
-}\r
-\r
-/** Event handler for the library USB Disconnection event. */\r
-void EVENT_USB_Device_Disconnect(void)\r
-{\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-}\r
-\r
-/** Event handler for the library USB Configuration Changed event. */\r
-void EVENT_USB_Device_ConfigurationChanged(void)\r
-{\r
-       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
-\r
-       if (!(HID_Device_ConfigureEndpoints(&Generic_HID_Interface)))\r
-         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-\r
-       USB_Device_EnableSOFEvents();\r
-}\r
-\r
-/** Event handler for the library USB Unhandled Control Request event. */\r
-void EVENT_USB_Device_UnhandledControlRequest(void)\r
-{\r
-       HID_Device_ProcessControlRequest(&Generic_HID_Interface);\r
-}\r
-\r
-/** Event handler for the USB device Start Of Frame event. */\r
-void EVENT_USB_Device_StartOfFrame(void)\r
-{\r
-       HID_Device_MillisecondElapsed(&Generic_HID_Interface);\r
-}\r
-\r
-/** HID class driver callback function for the creation of HID reports to the host.\r
- *\r
- *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
- *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID\r
- *  \param[out] ReportData  Pointer to a buffer where the created report should be stored\r
- *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent\r
- *\r
- *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent\r
- */\r
-bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
-                                         void* ReportData, uint16_t* ReportSize)\r
-{\r
-       if (HIDReportEcho.ReportID)\r
-         *ReportID = HIDReportEcho.ReportID;\r
-\r
-       memcpy(ReportData, HIDReportEcho.ReportData, HIDReportEcho.ReportSize);\r
-       \r
-       *ReportSize = HIDReportEcho.ReportSize;\r
-       return true;\r
-}\r
-\r
-/** HID class driver callback function for the processing of HID reports from the host.\r
- *\r
- *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
- *  \param[in] ReportID  Report ID of the received report from the host\r
- *  \param[in] ReportData  Pointer to a buffer where the created report has been stored\r
- *  \param[in] ReportSize  Size in bytes of the received HID report\r
- */\r
-void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
-                                          const void* ReportData, const uint16_t ReportSize)\r
-{\r
-       HIDReportEcho.ReportID   = ReportID;\r
-       HIDReportEcho.ReportSize = ReportSize;\r
-       memcpy(HIDReportEcho.ReportData, ReportData, ReportSize);\r
-}\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2013.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, 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 disclaims 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 GenericHID demo. This file contains the main tasks of
+ *  the demo and is responsible for the initial application hardware configuration.
+ */
+
+#include "GenericHID.h"
+
+/** Buffer to hold the previously generated HID report, for comparison purposes inside the HID class driver. */
+static uint8_t PrevHIDReportBuffer[GENERIC_REPORT_SIZE];
+
+/** 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.
+ */
+USB_ClassInfo_HID_Device_t Generic_HID_Interface =
+       {
+               .Config =
+                       {
+                               .InterfaceNumber              = 0,
+                               .ReportINEndpoint             =
+                                       {
+                                               .Address              = GENERIC_IN_EPADDR,
+                                               .Size                 = GENERIC_EPSIZE,
+                                               .Banks                = 1,
+                                       },
+                               .PrevReportINBuffer           = PrevHIDReportBuffer,
+                               .PrevReportINBufferSize       = sizeof(PrevHIDReportBuffer),
+                       },
+       };
+
+
+/** 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);
+       GlobalInterruptEnable();
+
+       for (;;)
+       {
+               HID_Device_USBTask(&Generic_HID_Interface);
+               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 */
+       LEDs_Init();
+       USB_Init();
+}
+
+/** Event handler for the library USB Connection event. */
+void EVENT_USB_Device_Connect(void)
+{
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+}
+
+/** Event handler for the library USB Disconnection event. */
+void EVENT_USB_Device_Disconnect(void)
+{
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+}
+
+/** Event handler for the library USB Configuration Changed event. */
+void EVENT_USB_Device_ConfigurationChanged(void)
+{
+       bool ConfigSuccess = true;
+
+       ConfigSuccess &= HID_Device_ConfigureEndpoints(&Generic_HID_Interface);
+
+       USB_Device_EnableSOFEvents();
+
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
+}
+
+/** Event handler for the library USB Control Request reception event. */
+void EVENT_USB_Device_ControlRequest(void)
+{
+       HID_Device_ProcessControlRequest(&Generic_HID_Interface);
+}
+
+/** Event handler for the USB device Start Of Frame event. */
+void EVENT_USB_Device_StartOfFrame(void)
+{
+       HID_Device_MillisecondElapsed(&Generic_HID_Interface);
+}
+
+/** HID class driver callback function for the creation of HID reports to the host.
+ *
+ *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
+ *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
+ *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
+ *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
+ *
+ *  \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
+ */
+bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
+                                         uint8_t* const ReportID,
+                                         const uint8_t ReportType,
+                                         void* ReportData,
+                                         uint16_t* const ReportSize)
+{
+       uint8_t* Data = (uint8_t*)ReportData;
+       uint8_t  CurrLEDMask = LEDs_GetLEDs();
+
+       Data[0] = ((CurrLEDMask & LEDS_LED1) ? 1 : 0);
+       Data[1] = ((CurrLEDMask & LEDS_LED2) ? 1 : 0);
+       Data[2] = ((CurrLEDMask & LEDS_LED3) ? 1 : 0);
+       Data[3] = ((CurrLEDMask & LEDS_LED4) ? 1 : 0);
+
+       *ReportSize = GENERIC_REPORT_SIZE;
+       return false;
+}
+
+/** HID class driver callback function for the processing of HID reports from the host.
+ *
+ *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
+ *  \param[in] ReportID    Report ID of the received report from the host
+ *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
+ *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
+ *  \param[in] ReportSize  Size in bytes of the received HID report
+ */
+void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
+                                          const uint8_t ReportID,
+                                          const uint8_t ReportType,
+                                          const void* ReportData,
+                                          const uint16_t ReportSize)
+{
+       uint8_t* Data = (uint8_t*)ReportData;
+       uint8_t  NewLEDMask = LEDS_NO_LEDS;
+
+       if (Data[0])
+         NewLEDMask |= LEDS_LED1;
+
+       if (Data[1])
+         NewLEDMask |= LEDS_LED2;
+
+       if (Data[2])
+         NewLEDMask |= LEDS_LED3;
+
+       if (Data[3])
+         NewLEDMask |= LEDS_LED4;
+
+       LEDs_SetAllLEDs(NewLEDMask);
+}
+