+ /** 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 HID_Host_SetBootProtocol() or \ref 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] ConfigDescriptorSize 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* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,\r
+ void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r
+\r
+\r
+ /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.\r
+ * \r
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\r
+ *\r
+ * \note The destination buffer should be large enough to accommodate the largest report that the attached device\r
+ * can generate.\r
+ *\r
+ * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state\r
+ * \param[in] Buffer Buffer to store the received report into\r
+ *\r
+ * \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
+ */\r
+ uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer)\r
+ ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+\r
+ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ /** Receives a HID IN report from the attached device, by the report ID.\r
+ *\r
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\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
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\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) ATTR_NON_NULL_PTR_ARG(3);\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 This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\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
+ * \param[in] ReportSize Report size in bytes to send to the attached device\r
+ *\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,\r
+ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ const uint8_t ReportID,\r
+ #endif\r
+ void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)\r
+ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+ ATTR_NON_NULL_PTR_ARG(3);\r
+ #else\r
+ ATTR_NON_NULL_PTR_ARG(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
+ * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+ * call will fail.\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* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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
+ * \ref USB_Host_SendControlErrorCodes_t enum otherwise\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
+ * 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 HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+ #endif\r
+ \r
+ /* Inline Functions: */\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
+ static inline void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo);\r
+ static inline void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
+ {\r
+ (void)HIDInterfaceInfo;\r
+ } \r
+\r
projects / pub / USBasp.git / blobdiff