Add const qualifiers to Host mode Class drivers.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / HID.h
index 230930a..a8865a5 100644 (file)
                         *\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
+                       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
                         *        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] 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* HIDInterfaceInfo, uint16_t ConfigDescriptorLength,\r
+                       uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,\r
                                                        uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r
 \r
                         *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the ControlRequest flag is set,\r
                         *          a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise\r
                         */\r
-                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool ControlRequest, uint8_t* ReportID,\r
+                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const bool ControlRequest, uint8_t* ReportID,\r
                                                       void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 3);\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
                         *  \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_SendReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint8_t ReportID,\r
-                                                   void* Buffer, uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                       uint8_t HID_Host_SendReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
+                                                   void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r
                        /** Determines if a HID IN report has been received from the attached device on the data IN pipe.\r
                         *\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
+                       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
                         *  \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
+                       uint8_t USB_HID_Host_SetBootProtocol(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 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
                         *          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
+                       uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r