#include "VirtualSerialHost.h"
/* Macros: */
- /** Interface Class value for the CDC class */
+ /** Interface Class value for the CDC class. */
#define CDC_CONTROL_CLASS 0x02
- /** Interface Class value for the CDC Communication Interface subclass */
+ /** Interface Class value for the CDC Communication Interface subclass. */
#define CDC_CONTROL_SUBCLASS 0x02
- /** Interface Class value for the CDC protocol */
+ /** Interface Class value for the CDC protocol. */
#define CDC_CONTROL_PROTOCOL 0x01
- /** Interface Class value for the CDC data class */
+ /** Interface Class value for the CDC data class. */
#define CDC_DATA_CLASS 0x0A
- /** Interface Class value for the CDC data subclass */
+ /** Interface Class value for the CDC data subclass. */
#define CDC_DATA_SUBCLASS 0x00
- /** Interface Class value for the CDC data protocol */
+ /** Interface Class value for the CDC data protocol. */
#define CDC_DATA_PROTOCOL 0x00
+ /** Pipe number for the CDC data IN pipe. */
+ #define CDC_DATA_IN_PIPE 1
+
+ /** Pipe number for the CDC data OUT pipe. */
+ #define CDC_DATA_OUT_PIPE 2
+
+ /** Pipe number for the CDC notification pipe. */
+ #define CDC_NOTIFICATION_PIPE 3
+
/* Enums: */
- /** Enum for the possible return codes of the ProcessConfigurationDescriptor() function. */
+ /** Enum for the possible return codes of the \ref ProcessConfigurationDescriptor() function. */
enum CDCHost_GetConfigDescriptorDataCodes_t
{
SuccessfulConfigRead = 0, /**< Configuration Descriptor was processed successfully */
ControlError = 1, /**< A control request to the device failed to complete successfully */
DescriptorTooLarge = 2, /**< The device's Configuration Descriptor is too large to process */
InvalidConfigDataReturned = 3, /**< The device returned an invalid Configuration Descriptor */
- NoCDCInterfaceFound = 4, /**< A compatible CDC interface was not found in the device's Configuration Descriptor */
- NoEndpointFound = 5, /**< Compatible CDC endpoints were not found in the device's CDC interface */
+ NoCompatibleInterfaceFound = 4, /**< A compatible interface with the required endpoints was not found */
};
/* Function Prototypes: */