\r
# LUFA library compile-time options\r
LUFA_OPTS += -D USB_HOST_ONLY\r
+LUFA_OPTS += -D HID_HOST_BOOT_PROTOCOL_ONLY\r
LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"\r
\r
\r
\r
# LUFA library compile-time options\r
LUFA_OPTS += -D USB_HOST_ONLY\r
+LUFA_OPTS += -D HID_HOST_BOOT_PROTOCOL_ONLY\r
LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)"\r
\r
\r
\r
}\r
\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID, void* Buffer)\r
{\r
USB_ControlRequest = (USB_Request_Header_t)\r
\r
return USB_Host_SendControlRequest(Buffer);\r
} \r
- \r
+#endif\r
+ \r
uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer)\r
{\r
if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
\r
uint16_t ReportSize;\r
\r
- if (HIDInterfaceInfo->State.UsingBootProtocol)\r
- {\r
- ReportSize = Pipe_BytesInPipe();\r
- }\r
- else\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ if (!(HIDInterfaceInfo->State.UsingBootProtocol))\r
{\r
uint8_t ReportID = 0;\r
\r
\r
ReportSize = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, ReportID, REPORT_ITEM_TYPE_In);\r
}\r
+ else\r
+#endif\r
+ {\r
+ ReportSize = Pipe_BytesInPipe();\r
+ }\r
\r
if ((ErrorCode = Pipe_Read_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)\r
return ErrorCode;\r
return PIPE_RWSTREAM_NoError;\r
}\r
\r
-uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint8_t ReportID, void* Buffer,\r
- const uint16_t ReportSize)\r
+uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ const uint8_t ReportID,\r
+#endif\r
+ void* Buffer, const uint16_t ReportSize)\r
{\r
if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
return false;\r
- \r
- if (!(HIDInterfaceInfo->State.DeviceUsesOUTPipe))\r
- {\r
- USB_ControlRequest = (USB_Request_Header_t)\r
- {\r
- .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
- .bRequest = REQ_SetReport,\r
- .wValue = ReportID,\r
- .wIndex = HIDInterfaceInfo->State.InterfaceNumber,\r
- .wLength = ReportSize,\r
- };\r
\r
- Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
- \r
- return USB_Host_SendControlRequest(Buffer);\r
- }\r
- else\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ if (HIDInterfaceInfo->State.DeviceUsesOUTPipe)\r
{\r
uint8_t ErrorCode;\r
\r
\r
return PIPE_RWSTREAM_NoError;\r
}\r
+ else\r
+#endif\r
+ {\r
+ USB_ControlRequest = (USB_Request_Header_t)\r
+ {\r
+ .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+ .bRequest = REQ_SetReport,\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ .wValue = ReportID,\r
+#else\r
+ .wValue = 0,\r
+#endif\r
+ .wIndex = HIDInterfaceInfo->State.InterfaceNumber,\r
+ .wLength = ReportSize,\r
+ };\r
+\r
+ Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+ \r
+ return USB_Host_SendControlRequest(Buffer);\r
+ }\r
}\r
\r
bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
return HOST_SENDCONTROL_Successful;\r
}\r
\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
{\r
uint8_t ErrorCode;\r
\r
return 0;\r
}\r
+#endif\r
\r
#endif\r
* \ref HID_BOOT_KEYBOARD_PROTOCOL or \ref HID_NON_BOOT_PROTOCOL if any\r
* HID device should be enumerated by the interface\r
*/\r
+ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol\r
- * is not used */\r
+ * is not used\r
+ *\r
+ * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined,\r
+ * this method is unavailable.\r
+ */\r
+ #endif\r
} Config; /**< Config data for the USB class interface within the device. All elements in this section\r
* <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
*/\r
*/\r
uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
+ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
/** Received a HID IN report from the attached device, by the report ID.\r
*\r
+ * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
+ *\r
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state\r
* \param[in] ReportID Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch\r
* \param[in] Buffer Buffer to store the received report into\r
*/\r
uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 3);\r
-\r
+ #endif\r
+ \r
/** Sends an OUT report to the currently attached HID device, using the device's OUT pipe if available or the device's\r
* Control pipe if not.\r
*\r
+ * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed\r
+ * from the parameter list of this function.\r
+ *\r
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state\r
* \param[in] ReportID Report ID of the report to send to the device, or 0 if the device does not use report IDs\r
* \param[in] Buffer Buffer containing the report to send to the attached device\r
* \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in\r
* the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise\r
*/\r
- uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
- void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+ uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,\r
+ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ const uint8_t ReportID,\r
+ #endif\r
+ void* Buffer, const uint16_t ReportSize)\r
+ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ ATTR_NON_NULL_PTR_ARG(1, 3);\r
+ #else\r
+ ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ #endif\r
\r
/** Determines if a HID IN report has been received from the attached device on the data IN pipe.\r
*\r
\r
/** Switches the attached HID device's reporting protocol over to the Boot Report protocol mode, on supported devices.\r
*\r
+ * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method must still be called\r
+ * to explicitly place the attached device into boot protocol mode before use.\r
+ *\r
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state\r
*\r
* \return \ref HID_ERROR_LOGICAL if the device does not support Boot Protocol mode, a value from the\r
*/\r
uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
+ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
/** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves\r
* and parses the device's HID report descriptor, so that the size of each report can be determined in advance.\r
*\r
* \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID\r
* Report Parser this function references <b>must</b> be implemented in the user code.\r
*\r
+ * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
+ *\r
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state\r
*\r
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum if an error occurs while retrieving the HID\r
* and a value from the \ref HID_Parse_ErrorCodes_t otherwise\r
*/\r
uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
- \r
+ #endif\r
+ \r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/* Macros: */\r
*\r
* <b>New:</b>\r
* - Added new Dual Role Keyboard/Mouse demo\r
+ * - Added new HID_HOST_BOOT_PROTOCOL_ONLY compile time token to reduce the size of the HID Host Class driver when\r
+ * Report protocol is not needed\r
*\r
* <b>Changed:</b>\r
* - Removed mostly useless "TestApp" demo, as it was mainly useful only for checking for sytax errors in the library\r
* this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from\r
* the source code at compile time.\r
*\r
+ *\r
* \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens\r
* This section describes compile tokens which affect USB class-specific drivers in the LUFA library.\r
*\r
+ * <b>HID_HOST_BOOT_PROTOCOL_ONLY</b> - ( \ref Group_USBClassHIDHost ) \n\r
+ * By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID\r
+ * communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic\r
+ * Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol\r
+ * mode can be removed to save space in the compiled application by defining this token. When defined, it is still neccesary\r
+ * to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol().\r
+ * \r
* <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - ( \ref Group_HIDParser ) \n\r
* HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This\r
* allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous\r
* and their sizes calculated/stored into the resultant processed report structure. If not defined, this defaults to the value indicated in\r
* the HID.h file documentation.\r
*\r
+ *\r
* \section Sec_SummaryUSBTokens USB Driver Related Tokens\r
* This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.\r
*\r
* areas relevant to making older projects compatible with the API changes of each new release.\r
*\r
* \section Sec_MigrationXXXXXX Migrating from 090810 to XXXXXX\r
+ * <b>No Migration information for this release.</b>\r
*\r
* \section Sec_Migration090924 Migrating from 090810 to 090924\r
*\r
projects / pub / USBasp.git / commitdiff