Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / HID.c
index f292c63..3b0f87a 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
-#include "../../HighLevel/USBMode.h"\r
-#if defined(USB_CAN_BE_DEVICE)\r
-\r
-#include "HID.h"\r
-\r
-void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)\r
-{\r
-       if (!(Endpoint_IsSETUPReceived()))\r
-         return;\r
-         \r
-       if ((USB_ControlRequest.wIndex   != HIDInterfaceInfo->Config.InterfaceNumber) &&\r
-           (USB_ControlRequest.bRequest != REQ_SetIdle))\r
-       {\r
-               return;\r
-       }\r
-\r
-       switch (USB_ControlRequest.bRequest)\r
-       {\r
-               case REQ_GetReport:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();  \r
-\r
-                               uint8_t  ReportINData[HIDInterfaceInfo->Config.ReportINBufferSize];\r
-                               uint16_t ReportINSize;\r
-                               uint8_t  ReportID = (USB_ControlRequest.wValue & 0xFF);\r
-\r
-                               memset(ReportINData, 0, sizeof(ReportINData));\r
-                               \r
-                               ReportINSize = CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, ReportINData);\r
-\r
-                               Endpoint_Write_Control_Stream_LE(ReportINData, ReportINSize);\r
-                               Endpoint_ClearOUT();\r
-                       }\r
-               \r
-                       break;\r
-               case REQ_SetReport:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               uint16_t ReportOUTSize = USB_ControlRequest.wLength;\r
-                               uint8_t  ReportOUTData[ReportOUTSize];\r
-                               uint8_t  ReportID = (USB_ControlRequest.wValue & 0xFF);\r
-\r
-                               Endpoint_Read_Control_Stream_LE(ReportOUTData, ReportOUTSize);\r
-                               Endpoint_ClearIN();\r
-                               \r
-                               CALLBACK_HID_Device_ProcessHIDReport(HIDInterfaceInfo, ReportID, ReportOUTData, ReportOUTSize);\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_GetProtocol:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();\r
-\r
-                               Endpoint_Write_Byte(HIDInterfaceInfo->State.UsingReportProtocol);\r
-                               Endpoint_ClearIN();\r
-\r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_SetProtocol:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();\r
-\r
-                               HIDInterfaceInfo->State.UsingReportProtocol = (USB_ControlRequest.wValue != 0x0000);\r
-                               \r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_SetIdle:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               if ((USB_ControlRequest.wIndex         == HIDInterfaceInfo->Config.InterfaceNumber) ||\r
-                                   (USB_ControlRequest.wValue & 0xFF) == 0)\r
-                               {\r
-                                       Endpoint_ClearSETUP();\r
-                                       \r
-                                       HIDInterfaceInfo->State.IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);\r
-                                       \r
-                                       Endpoint_ClearStatusStage();\r
-                               }\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_GetIdle:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {               \r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               Endpoint_Write_Byte(HIDInterfaceInfo->State.IdleCount >> 2);\r
-                               Endpoint_ClearIN();\r
-\r
-                               Endpoint_ClearStatusStage();\r
-                       }\r
-\r
-                       break;\r
-       }\r
-}\r
-\r
-bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)\r
-{\r
-       HIDInterfaceInfo->State.UsingReportProtocol = true;\r
-\r
-       if (!(Endpoint_ConfigureEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber, EP_TYPE_INTERRUPT,\r
-                                                                        ENDPOINT_DIR_IN, HIDInterfaceInfo->Config.ReportINEndpointSize, ENDPOINT_BANK_SINGLE)))\r
-       {\r
-               return false;\r
-       }\r
-       \r
-       return true;\r
-}\r
-               \r
-void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)\r
-{\r
-       if (USB_DeviceState != DEVICE_STATE_Configured)\r
-         return;\r
-\r
-       Endpoint_SelectEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber);\r
-       \r
-       if (Endpoint_IsReadWriteAllowed() &&\r
-           !(HIDInterfaceInfo->State.IdleCount && HIDInterfaceInfo->State.IdleMSRemaining))\r
-       {\r
-               if (HIDInterfaceInfo->State.IdleCount && !(HIDInterfaceInfo->State.IdleMSRemaining))\r
-                 HIDInterfaceInfo->State.IdleMSRemaining = HIDInterfaceInfo->State.IdleCount;\r
-\r
-               uint8_t  ReportINData[HIDInterfaceInfo->Config.ReportINBufferSize];\r
-               uint16_t ReportINSize;\r
-               uint8_t  ReportID = 0;\r
-\r
-               memset(ReportINData, 0, sizeof(ReportINData));\r
-\r
-               ReportINSize = CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, ReportINData);\r
-\r
-               if (ReportINSize)\r
-               {\r
-                       if (ReportID)\r
-                         Endpoint_Write_Stream_LE(&ReportID, sizeof(ReportID), NO_STREAM_CALLBACK);\r
-\r
-                       Endpoint_Write_Stream_LE(ReportINData, ReportINSize, NO_STREAM_CALLBACK);\r
-               }\r
-               \r
-               Endpoint_ClearIN();\r
-       }\r
-}\r
-\r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  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 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.
+*/
+
+#define  __INCLUDE_FROM_USB_DRIVER
+#include "../../Core/USBMode.h"
+
+#if defined(USB_CAN_BE_DEVICE)
+
+#define  __INCLUDE_FROM_HID_DRIVER
+#define  __INCLUDE_FROM_HID_DEVICE_C
+#include "HID.h"
+
+void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
+{
+       if (!(Endpoint_IsSETUPReceived()))
+         return;
+
+       if (USB_ControlRequest.wIndex != HIDInterfaceInfo->Config.InterfaceNumber)
+         return;
+
+       switch (USB_ControlRequest.bRequest)
+       {
+               case HID_REQ_GetReport:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               uint16_t ReportSize = 0;
+                               uint8_t  ReportID   = (USB_ControlRequest.wValue & 0xFF);
+                               uint8_t  ReportType = (USB_ControlRequest.wValue >> 8) - 1;
+                               uint8_t  ReportData[HIDInterfaceInfo->Config.PrevReportINBufferSize];
+
+                               memset(ReportData, 0, sizeof(ReportData));
+
+                               CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, ReportType, ReportData, &ReportSize);
+
+                               if (HIDInterfaceInfo->Config.PrevReportINBuffer != NULL)
+                               {
+                                       memcpy(HIDInterfaceInfo->Config.PrevReportINBuffer, ReportData,
+                                              HIDInterfaceInfo->Config.PrevReportINBufferSize);
+                               }
+                               
+                               Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);
+
+                               Endpoint_ClearSETUP();
+                               Endpoint_Write_Control_Stream_LE(ReportData, ReportSize);
+                               Endpoint_ClearOUT();
+                       }
+
+                       break;
+               case HID_REQ_SetReport:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               uint16_t ReportSize = USB_ControlRequest.wLength;
+                               uint8_t  ReportID   = (USB_ControlRequest.wValue & 0xFF);
+                               uint8_t  ReportType = (USB_ControlRequest.wValue >> 8) - 1;
+                               uint8_t  ReportData[ReportSize];
+
+                               Endpoint_ClearSETUP();
+                               Endpoint_Read_Control_Stream_LE(ReportData, ReportSize);
+                               Endpoint_ClearIN();
+                               
+                               CALLBACK_HID_Device_ProcessHIDReport(HIDInterfaceInfo, ReportID, ReportType,
+                                                                    &ReportData[ReportID ? 1 : 0], ReportSize - (ReportID ? 1 : 0));
+                       }
+
+                       break;
+               case HID_REQ_GetProtocol:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+                               Endpoint_Write_8(HIDInterfaceInfo->State.UsingReportProtocol);
+                               Endpoint_ClearIN();
+                               Endpoint_ClearStatusStage();
+                       }
+
+                       break;
+               case HID_REQ_SetProtocol:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+                               Endpoint_ClearStatusStage();
+
+                               HIDInterfaceInfo->State.UsingReportProtocol = ((USB_ControlRequest.wValue & 0xFF) != 0x00);
+                       }
+
+                       break;
+               case HID_REQ_SetIdle:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+                               Endpoint_ClearStatusStage();
+
+                               HIDInterfaceInfo->State.IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
+                       }
+
+                       break;
+               case HID_REQ_GetIdle:
+                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
+                       {
+                               Endpoint_ClearSETUP();
+                               Endpoint_Write_8(HIDInterfaceInfo->State.IdleCount >> 2);
+                               Endpoint_ClearIN();
+                               Endpoint_ClearStatusStage();
+                       }
+
+                       break;
+       }
+}
+
+bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
+{
+       memset(&HIDInterfaceInfo->State, 0x00, sizeof(HIDInterfaceInfo->State));
+       HIDInterfaceInfo->State.UsingReportProtocol = true;
+       HIDInterfaceInfo->State.IdleCount           = 500;
+
+       if (!(Endpoint_ConfigureEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber, EP_TYPE_INTERRUPT,
+                                                                        ENDPOINT_DIR_IN, HIDInterfaceInfo->Config.ReportINEndpointSize,
+                                                                        HIDInterfaceInfo->Config.ReportINEndpointDoubleBank ? ENDPOINT_BANK_DOUBLE : ENDPOINT_BANK_SINGLE)))
+       {
+               return false;
+       }
+
+       return true;
+}
+
+void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
+{
+       if (USB_DeviceState != DEVICE_STATE_Configured)
+         return;
+
+       Endpoint_SelectEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber);
+
+       if (Endpoint_IsReadWriteAllowed())
+       {
+               uint8_t  ReportINData[HIDInterfaceInfo->Config.PrevReportINBufferSize];
+               uint8_t  ReportID     = 0;
+               uint16_t ReportINSize = 0;
+
+               memset(ReportINData, 0, sizeof(ReportINData));
+
+               bool ForceSend         = CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, HID_REPORT_ITEM_In,
+                                                                            ReportINData, &ReportINSize);
+               bool StatesChanged     = false;
+               bool IdlePeriodElapsed = (HIDInterfaceInfo->State.IdleCount && !(HIDInterfaceInfo->State.IdleMSRemaining));
+
+               if (HIDInterfaceInfo->Config.PrevReportINBuffer != NULL)
+               {
+                       StatesChanged = (memcmp(ReportINData, HIDInterfaceInfo->Config.PrevReportINBuffer, ReportINSize) != 0);
+                       memcpy(HIDInterfaceInfo->Config.PrevReportINBuffer, ReportINData, HIDInterfaceInfo->Config.PrevReportINBufferSize);
+               }
+
+               if (ReportINSize && (ForceSend || StatesChanged || IdlePeriodElapsed))
+               {
+                       HIDInterfaceInfo->State.IdleMSRemaining = HIDInterfaceInfo->State.IdleCount;
+
+                       Endpoint_SelectEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber);
+
+                       if (ReportID)
+                         Endpoint_Write_8(ReportID);
+
+                       Endpoint_Write_Stream_LE(ReportINData, ReportINSize, NULL);
+
+                       Endpoint_ClearIN();
+               }
+       }
+}
+
+#endif
+