- /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
- * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
- *\r
- * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
- */\r
- void HID_Device_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
- \r
- /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either\r
- * HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
- * user is responsible for the creation of the next HID input report to be sent to the host.\r
- *\r
- * \param HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
- * \param 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
- * given HID interface, this parameter should be ignored.\r
- * \param ReportData Pointer to a buffer where the generated HID report should be stored.\r
- *\r
- * \return Number of bytes in the generated input report, or zero if no report is to be sent\r
- */\r
- uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
+ uint8_t ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
+ uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */ \r
+ bool ReportINEndpointDoubleBank; /** Indicates if the HID interface's IN report endpoint should use double banking */\r
+ \r
+ void* PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be\r
+ * stored by the driver, for comparison purposes to detect report changes that\r
+ * must be sent immediately to the host. This should point to a buffer big enough\r
+ * to hold the largest HID input report sent from the HID interface. If this is set\r
+ * to NULL, it is up to the user to force transfers when needed in the \r
+ * \ref CALLBACK_HID_Device_CreateHIDReport() callback function.\r
+ *\r
+ * \note Due to the single buffer, the internal driver can only correctly compare\r
+ * subsequent reports with identical report IDs. In multiple report devices,\r
+ * this buffer should be set to NULL and the decision to send reports made\r
+ * by the user application instead.\r
+ */\r
+ uint8_t PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a\r
+ * second buffer of the same size within the driver so that subsequent reports\r
+ * can be compared. If the user app is to determine when reports are to be sent\r
+ * exclusively (i.e. \ref PrevReportINBuffer is NULL) this value is ignored.\r
+ */\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
+ struct\r
+ {\r
+ bool UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */\r
+ uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host */\r
+ uint16_t IdleMSRemaining; /**< Total number of milliseconds remaining before the idle period elapsed - this \r
+ * should be decremented by the user application if non-zero each millisecond */ \r
+ } State; /**< State data for the USB class interface within the device. All elements in this section\r
+ * are reset to their defaults when the interface is enumerated.\r
+ */\r
+ } USB_ClassInfo_HID_Device_t;\r
+ \r
+ /* Function Prototypes: */\r
+ /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given HID interface is selected.\r
+ *\r
+ * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state\r
+ *\r
+ * \return Boolean true if the endpoints were successfully configured, false otherwise\r
+ */\r
+ bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+ \r
+ /** Processes incoming control requests from the host, that are directed to the given HID class interface. This should be\r
+ * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
+ *\r
+ * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state\r
+ */ \r
+ void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
projects / pub / USBasp.git / blobdiff