Add HID Host Class driver functions to set the report protocol, add more class driver documentation.
USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
break;\r
}\r
+\r
+ if (USB_HID_Host_SetBootProtocol(&Mouse_HID_Interface) != 0)\r
+ {\r
+ printf("Could not Set Boot Protocol Mode.\r\n");\r
+ LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+ USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+ break;\r
+ }\r
\r
printf("Mouse Enumerated.\r\n");\r
USB_HostState = HOST_STATE_Configured;\r
*\r
* \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
* \param[in,out] ReportID If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should\r
- * be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
+ * be set to the report ID of the generated HID input report (if any). If multiple reports are not sent via the\r
* given HID interface, this parameter should be ignored.\r
* \param[out] ReportData Pointer to a buffer where the generated HID report should be stored.\r
* \param[out] ReportSize Number of bytes in the generated input report, or zero if no report is to be sent\r
* values of the interface have been changed to push the new settings to the USB device.\r
*\r
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state\r
+ *\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
*/\r
uint8_t CDC_Host_SetLineEncoding(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
* to push the new states to the USB device.\r
*\r
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state\r
+ *\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
*/\r
uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
return ReportReceived;\r
}\r
\r
-uint8_t USB_HID_Host_SetProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool UseReportProtocol)\r
+uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)\r
{\r
+ if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
+ return false;\r
+\r
USB_ControlRequest = (USB_Request_Header_t)\r
{\r
.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
.bRequest = REQ_SetProtocol,\r
- .wValue = UseReportProtocol,\r
+ .wValue = 1,\r
.wIndex = HIDInterfaceInfo->State.InterfaceNumber,\r
.wLength = 0,\r
};\r
\r
Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
\r
- if (UseReportProtocol && !(HIDInterfaceInfo->State.SupportsBootSubClass))\r
- return MS_ERROR_UNSUPPORTED;\r
+ if (!(HIDInterfaceInfo->State.SupportsBootSubClass))\r
+ return HID_ERROR_LOGICAL;\r
\r
return USB_Host_SendControlRequest(NULL);\r
}\r
\r
+uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)\r
+{\r
+ if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
+ return false;\r
+\r
+ uint8_t ErrorCode;\r
+\r
+ uint8_t HIDReportData[HIDInterfaceInfo->State.HIDReportSize];\r
+ \r
+ USB_ControlRequest = (USB_Request_Header_t)\r
+ {\r
+ .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),\r
+ .bRequest = REQ_GetDescriptor,\r
+ .wValue = (DTYPE_Report << 8),\r
+ .wIndex = HIDInterfaceInfo->State.InterfaceNumber,\r
+ .wLength = HIDInterfaceInfo->State.HIDReportSize,\r
+ };\r
+\r
+ Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+\r
+ if ((ErrorCode = USB_Host_SendControlRequest(HIDReportData)) != HOST_SENDCONTROL_Successful)\r
+ return ErrorCode;\r
+ \r
+ USB_ControlRequest = (USB_Request_Header_t)\r
+ {\r
+ .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+ .bRequest = REQ_SetProtocol,\r
+ .wValue = 0,\r
+ .wIndex = HIDInterfaceInfo->State.InterfaceNumber,\r
+ .wLength = 0,\r
+ };\r
+\r
+ if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
+ return ErrorCode;\r
+\r
+ if (HIDInterfaceInfo->Config.HIDParserData == NULL)\r
+ return HID_ERROR_LOGICAL;\r
+ \r
+ if ((ErrorCode = USB_ProcessHIDReport(HIDReportData, HIDInterfaceInfo->State.HIDReportSize,\r
+ HIDInterfaceInfo->Config.HIDParserData)) != HID_PARSE_Successful)\r
+ {\r
+ return HID_ERROR_LOGICAL | ErrorCode;\r
+ }\r
+ \r
+ return 0;\r
+}\r
+\r
#endif\r
* \section Sec_Dependencies Module Source Dependencies\r
* The following files must be built with any user project that uses this module:\r
* - LUFA/Drivers/USB/Class/Host/HID.c\r
+ * - LUFA/Drivers/USB/Class/Host/HIDParser.c\r
*\r
* \section Module Description\r
* Host Mode USB Class driver framework interface, for the HID USB Class driver.\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
/** Error code for some HID Host functions, indicating a logical (and not hardware) error */\r
- #define MS_ERROR_UNSUPPORTED 0xC0\r
+ #define HID_ERROR_LOGICAL 0x80\r
\r
/* Type Defines: */\r
/** Class state structure. An instance of this structure should be made within the user application,\r
uint16_t DataOUTPipeSize; /**< Size in bytes of the HID interface's OUT data pipe */\r
\r
bool SupportsBootSubClass; /**< Indicates if the current interface instance supports the HID Boot\r
- * Protocol when enabled via \ref USB_HID_Host_SetProtocol()\r
+ * Protocol when enabled via \ref USB_HID_Host_SetBootProtocol()\r
*/\r
uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device */\r
} State; /**< State data for the USB class interface within the device. All elements in this section\r
} USB_ClassInfo_HID_Host_t;\r
\r
/* Enums: */\r
+ /** Enum for the possible error codes returned by the \ref HID_Host_ConfigurePipes() function. */\r
enum HIDHost_EnumerationFailure_ErrorCodes_t\r
{\r
HID_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */\r
};\r
\r
/* Function Prototypes: */\r
+ /** General management task for a given Human Interface Class host class interface, required for the correct operation of\r
+ * the interface. This should be called frequently in the main program loop, before the master USB management task\r
+ * \ref USB_USBTask().\r
+ *\r
+ * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state\r
+ */\r
void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+ /** Host interface configuration routine, to configure a given HID host interface instance using the Configuration\r
+ * Descriptor read from an attached USB device. This function automatically updates the given HID Host instance's\r
+ * state values and configures the pipes required to communicate with the interface if it is found within the\r
+ * device. This should be called once after the stack has enumerated the attached device, while the host state\r
+ * machine is in the Addressed state.\r
+ *\r
+ * \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call\r
+ * to either the \ref USB_HID_Host_SetBootProtocol() or \ref USB_HID_Host_SetReportProtocol() function.\r
+ *\r
+ * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state\r
+ * \param[in] ConfigDescriptorLength Length of the attached device's Configuration Descriptor\r
+ * \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor\r
+ *\r
+ * \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum\r
+ */\r
uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorLength,\r
uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
\r
+ /** Determines if a report has been received on the HID interface's IN report pipe, when the device is initialized\r
+ * into Report Protocol mode.\r
+ *\r
+ * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state\r
+ *\r
+ * \return Boolean true if a report has been received, false otherwise\r
+ */\r
bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
- uint8_t USB_HID_Host_SetProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool UseReportProtocol) ATTR_NON_NULL_PTR_ARG(1);\r
+ /** Switches the attached HID device's reporting protocol over to the Boot Report protocol mode, on supported devices.\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
+ * \ref USB_Host_SendControlErrorCodes_t enum otherwise\r
+ */\r
+ uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\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
+ * \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
+ * Report descriptor or the setting of the Report protocol, \ref HID_ERROR_LOGICAL if the HID interface does\r
+ * not have a valid \ref HID_ReportInfo_t structure set in its configuration, a mask of \ref HID_ERROR_LOGICAL\r
+ * and a value from the \ref HID_Parse_ErrorCodes_t otherwise\r
+ */\r
+ uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
\r
if ((ErrorCode = Pipe_Read_Stream_LE(SCSICommandStatus, sizeof(MS_CommandStatusWrapper_t),\r
NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)\r
- return ErrorCode;\r
- \r
+ {\r
+ return ErrorCode;\r
+ }\r
+ \r
Pipe_ClearIN();\r
Pipe_Freeze();\r
\r
\r
Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
\r
- if ((ErrorCode = USB_Host_SendControlRequest(MaxLUNIndex)) == HOST_SENDCONTROL_SetupStalled)\r
- {\r
- Pipe_ClearStall();\r
-\r
- *MaxLUNIndex = 0;\r
- }\r
+ if ((ErrorCode = USB_Host_SendControlRequest(MaxLUNIndex)) != HOST_SENDCONTROL_Successful)\r
+ *MaxLUNIndex = 0;\r
\r
- return HOST_SENDCONTROL_SetupStalled;\r
+ return ErrorCode;\r
}\r
\r
uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex, SCSI_Inquiry_Response_t* InquiryData)\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
/** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error */\r
- #define MS_ERROR_LOGICAL_CMD_FAILED 0xC0\r
+ #define MS_ERROR_LOGICAL_CMD_FAILED 0x80\r
\r
/* Type Defines: */\r
/** Class state structure. An instance of this structure should be made within the user application,\r
/* Public Interface - May be used in end-application: */\r
/* Macros: */\r
/** Error code for some Still Image Host functions, indicating a logical (and not hardware) error */\r
- #define SI_ERROR_LOGICAL_CMD_FAILED 0xC0\r
+ #define SI_ERROR_LOGICAL_CMD_FAILED 0x80\r
\r
/* Type Defines: */\r
typedef struct\r
uint8_t USB_GetNextDescriptorComp(uint16_t* BytesRem, uint8_t** CurrConfigLoc, ConfigComparatorPtr_t ComparatorRoutine);\r
\r
/* Enums: */\r
+ /** Enum for the possible return codes of the \ref USB_GetDeviceConfigDescriptor() function. */\r
enum USB_Host_GetConfigDescriptor_ErrorCodes_t\r
{\r
HOST_GETCONFIG_Successful = 0, /**< No error occurred while retrieving the configuration descriptor */\r
* - Fix allowable F_CPU values comment in project makefiles to more accurately reflect the allowable values on the USB AVRs\r
* - Fixed DFU and CDC class bootloaders on the series 2 USB AVRs, corrected invalid signatures, added support for the new\r
* ATMEGAxxx2 series 2 variant AVRs to the DFU bootloader\r
- * - Fixed Low Level USBtoSerial demo not storing received characters (thanks to Michael from DirectAid.ca)\r
+ * - Fixed Low Level USBtoSerial demo not storing received characters (thanks to Michael Cooper)\r
* - Fixed MIDI Device Class driver not sending/receiving MIDI packets of the correct size (thanks to Thomas Bleeker)\r
*\r
*\r
projects / pub / lufa.git / commitdiff