this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB HID Class driver.\r
+ *\r
+ * Host mode driver for the library USB HID Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/HID.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassHID\r
* @defgroup Group_USBClassHIDHost HID Class Host Mode Driver\r
*\r
extern "C" {\r
#endif\r
\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_HID_DRIVER)\r
+ #error Do not include this file directly. Include LUFA/Drivers/Class/HID.h instead.\r
+ #endif\r
+\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 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
+ /** \brief HID Class Host Mode Configuration and State Structure.\r
+ *\r
+ * Class state structure. An instance of this structure should be made within the user application,\r
* and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This\r
* stores each HID interface's configuration and state information.\r
*/\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* const 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
* \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
+ * \n\n\r
*\r
* \note The destination buffer should be large enough to accommodate the largest report that the attached device\r
* can generate.\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
+ * \n\n\r
*\r
* \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
*\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
+ * \n\n\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
* \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
+ * \n\n\r
*\r
* \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\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
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/* Macros: */\r
#define HID_FOUND_DATAPIPE_OUT (1 << 1)\r
\r
/* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_HID_CLASS_HOST_C)\r
+ #if defined(__INCLUDE_FROM_HID_CLASS_HOST_C)\r
static uint8_t DComp_HID_Host_NextHIDInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
static uint8_t DComp_NextHID(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
projects / pub / USBasp.git / blobdiff