\r
/* Enums: */\r
/** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */\r
- enum\r
+ enum CDCHost_EnumerationFailure_ErrorCodes_t\r
{\r
CDC_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */\r
CDC_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */\r
CDC_ENUMERROR_NoCDCInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */\r
CDC_ENUMERROR_EndpointsNotFound = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface */\r
- } CDCHost_EnumerationFailure_ErrorCodes_t;\r
+ };\r
\r
/* Function Prototypes: */\r
/** General management task for a given CDC host class interface, required for the correct operation of the interface. This should\r
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing an CDC Class host configuration and state\r
* \param[in] ConfigDescriptorLength 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 CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, uint16_t ConfigDescriptorLength,\r
uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
} USB_ClassInfo_HID_Host_t;\r
\r
/* Enums: */\r
- enum\r
+ enum HIDHost_EnumerationFailure_ErrorCodes_t\r
{\r
HID_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */\r
HID_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */\r
HID_ENUMERROR_NoHIDInterfaceFound = 2, /**< A compatible HID interface was not found in the device's Configuration Descriptor */\r
HID_ENUMERROR_EndpointsNotFound = 3, /**< Compatible HID endpoints were not found in the device's HID interface */\r
- } HIDHost_EnumerationFailure_ErrorCodes_t;\r
+ };\r
\r
/* Function Prototypes: */\r
void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
} SCSI_Capacity_t;\r
\r
/* Enums: */\r
- enum\r
+ enum MSHost_EnumerationFailure_ErrorCodes_t\r
{\r
MS_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */\r
MS_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */\r
MS_ENUMERROR_NoMSInterfaceFound = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */\r
MS_ENUMERROR_EndpointsNotFound = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */\r
- } MSHost_EnumerationFailure_ErrorCodes_t;\r
+ };\r
\r
/* Function Prototypes: */\r
/** General management task for a given Mass Storage host class interface, required for the correct operation of\r
* \param[in,out] MSInterfaceInfo Pointer to a structure containing an MS Class host configuration and state\r
* \param[in] ConfigDescriptorLength 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 MSHost_EnumerationFailure_ErrorCodes_t enum\r
*/\r
uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint16_t ConfigDescriptorLength,\r
uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
* \param[in] LUNIndex LUN index within the device the command is being issued to\r
* \param[in] BlockAddress Starting block address within the device to read from\r
* \param[in] Blocks Total number of blocks to read\r
+ * \param[in] BlockSize Size in bytes of each block within the device\r
* \param[out] BlockBuffer Pointer to where the read data from the device should be stored\r
*\r
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
* \param[in] LUNIndex LUN index within the device the command is being issued to\r
* \param[in] BlockAddress Starting block address within the device to write to\r
* \param[in] Blocks Total number of blocks to read\r
+ * \param[in] BlockSize Size in bytes of each block within the device\r
* \param[in] BlockBuffer Pointer to where the data to write should be sourced from\r
*\r
* \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r