Partial commit: Rename USBFOO LED driver to fix capitalisation of file name, which...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / CDC.h

diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h
index 5f59e0c..455e2f9 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/CDC.h
+++ b/LUFA/Drivers/USB/Class/Host/CDC.h
@@ -38,7 +38,7 @@
  */
 
 /** \ingroup Group_USBClassCDC
- *  @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver
+ *  \defgroup Group_USBClassCDCHost CDC Class Host Mode Driver
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
@@ -58,7 +58,6 @@
                #include "../Common/CDC.h"
 
                #include <stdio.h>
-               #include <string.h>
 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
@@ -186,7 +185,7 @@
                         */
                        uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
-                       /** Sends a Send Break request to the device. This is generally used to separate data data or to indicate a special condition
+                       /** Sends a Send Break request to the device. This is generally used to separate data or to indicate a special condition
                         *  to the receiving device.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state.
@@ -286,7 +285,7 @@
                        uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
-                        *  functions in the avr-libc \c <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
+                        *  functions in the standard \c <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
                         *  stream is bidirectional and can be used for both input and output functions.
                         *
                         *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
@@ -296,6 +295,9 @@
                         *
                         *  \note The created stream can be given as stdout if desired to direct the standard output from all \c <stdio.h> functions
                         *        to the given CDC interface.
+                        *        \n\n
+                        *
+                        *  \note This function is not available on all microcontroller architectures.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
@@ -306,6 +308,8 @@
                        /** Identical to \ref CDC_Host_CreateStream(), except that reads are blocking until the calling stream function terminates
                         *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
                         *
+                        *  \note This function is not available on all microcontroller architectures.
+                        *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
                         */
@@ -326,10 +330,12 @@
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_CDC_HOST_C)
+                               #if defined(FDEV_SETUP_STREAM)
                                static int CDC_Host_putchar(char c,
                                                            FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
                                static int CDC_Host_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
                                static int CDC_Host_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
+                               #endif
 
                                void CDC_Host_Event_Stub(void) ATTR_CONST;
                                void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)