- /** 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
+ \r
+ uint8_t ReportINBufferSize; /**< Size of the largest possible report to send to the host, for\r
+ * buffer allocation purposes\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 ms, set by the host */\r
+ uint16_t IdleMSRemaining; /**< Total number of ms remaining before the idle period elapsed - this should be\r
+ * 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
+ * <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
+ * 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_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 sucessfully configured, false otherwise\r
+ */\r
+ bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+ \r
+ /** Processes incomming 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_UnhandledControlPacket() event.\r
+ *\r
+ * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
+ */ \r
+ void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+\r
+ /** 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[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class configuration and state.\r
+ */\r
+ void HID_Device_USBTask(USB_ClassInfo_HID_Device_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[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
+ * 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
+ *\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_Device_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
projects / pub / USBasp.git / blobdiff