Fixed SPI driver not explicitly setting /SS and MISO pins as inputs when SPI_Init...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / CDC.h
index 56bcf31..d7de77b 100644 (file)
                        
                /* Enums: */
                        /** Enum for the possible error codes returned by the \ref CDC_Host_ConfigurePipes() function. */
-                       enum CDCHost_EnumerationFailure_ErrorCodes_t
+                       enum CDC_Host_EnumerationFailure_ErrorCodes_t
                        {
                                CDC_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
                                CDC_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
-                               CDC_ENUMERROR_NoCDCInterfaceFound        = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor. */
-                               CDC_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible CDC endpoints were not found in the device's CDC interface. */
+                               CDC_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible CDC interface was not found in the device's Configuration Descriptor. */
                        };
        
                /* Function Prototypes: */
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
+                        *  \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other
+                        *        interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes
+                        *        within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.
+                        *
                         *  \param[in,out] CDCInterfaceInfo        Pointer to a structure containing an CDC Class host configuration and state.
                         *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
                         *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
                         *
-                        *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum.
+                        *  \return A value from the \ref CDC_Host_EnumerationFailure_ErrorCodes_t enum.
                         */
                        uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
                                                        uint16_t ConfigDescriptorSize,
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                        uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo,
-                                                   char* const Data,
+                                                   const char* const Data,
                                                    const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
                        
                        /** Sends a given byte to the attached USB device, if connected. If a device is not connected when the function is called, the
                        #define CDC_DATA_CLASS                  0x0A
                        #define CDC_DATA_SUBCLASS               0x00
                        #define CDC_DATA_PROTOCOL               0x00
-                       
-                       #define CDC_FOUND_DATAPIPE_IN           (1 << 0)
-                       #define CDC_FOUND_DATAPIPE_OUT          (1 << 1)
-                       #define CDC_FOUND_NOTIFICATION_IN       (1 << 2)
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_CDC_CLASS_HOST_C)
                                static uint8_t DCOMP_CDC_Host_NextCDCControlInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
                                static uint8_t DCOMP_CDC_Host_NextCDCDataInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
                                static uint8_t DCOMP_CDC_Host_NextCDCInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
-                       #endif  
+                       #endif
        #endif
                                
        /* Disable C linkage for C++ Compilers: */