Update UC3 platform driver support to use the bitmasks defined in the header files...

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

diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index 9e92d5f..6e188ad 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -33,24 +33,24 @@
  *
  *  Device mode driver for the library USB CDC Class driver.
  *
  *
  *  Device mode driver for the library USB CDC Class driver.
  *

- *  \note This file should not be included directly. It is automatically included as needed by the class driver
- *        dispatch header located in LUFA/Drivers/USB/Class/CDC.h.
+ *  \note This file should not be included directly. It is automatically included as needed by the USB module driver
+ *        dispatch header located in LUFA/Drivers/USB.h.

  */
 
 /** \ingroup Group_USBClassCDC
  */
 
 /** \ingroup Group_USBClassCDC

- *  @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver
+ *  \defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver

  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/CDC.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *

- *  \section Module Description
+ *  \section Sec_ModDescription Module Description

  *  Device Mode USB Class driver framework interface, for the CDC USB Class driver.
  *
  *  \note There are several major drawbacks to the CDC-ACM standard USB class, however
  *        it is very standardized and thus usually available as a built-in driver on
  *        most platforms, and so is a better choice than a proprietary serial class.
  *  Device Mode USB Class driver framework interface, for the CDC USB Class driver.
  *
  *  \note There are several major drawbacks to the CDC-ACM standard USB class, however
  *        it is very standardized and thus usually available as a built-in driver on
  *        most platforms, and so is a better choice than a proprietary serial class.

- *        
+ *

  *        One major issue with CDC-ACM is that it requires two Interface descriptors,
  *        which will upset most hosts when part of a multi-function "Composite" USB
  *        device, as each interface will be loaded into a separate driver instance. To
  *        One major issue with CDC-ACM is that it requires two Interface descriptors,
  *        which will upset most hosts when part of a multi-function "Composite" USB
  *        device, as each interface will be loaded into a separate driver instance. To


@@ -66,7 +66,7 @@
  *
  *  @{
  */
  *
  *  @{
  */

- 
+

 #ifndef _CDC_CLASS_DEVICE_H_
 #define _CDC_CLASS_DEVICE_H_
 
 #ifndef _CDC_CLASS_DEVICE_H_
 #define _CDC_CLASS_DEVICE_H_
 


@@ -75,7 +75,6 @@
                #include "../Common/CDC.h"
 
                #include <stdio.h>
                #include "../Common/CDC.h"
 
                #include <stdio.h>

-               #include <string.h>

 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)


@@ -84,9 +83,9 @@
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_CDC_DRIVER)
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_CDC_DRIVER)

-                       #error Do not include this file directly. Include LUFA/Drivers/Class/CDC.h instead.
+                       #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.

                #endif
                #endif

-               
+

        /* Public Interface - May be used in end-application: */
                /* Type Defines: */
                        /** \brief CDC Class Device Mode Configuration and State Structure.
        /* Public Interface - May be used in end-application: */
                /* Type Defines: */
                        /** \brief CDC Class Device Mode Configuration and State Structure.


@@ -119,46 +118,37 @@
                                {
                                        struct
                                        {
                                {
                                        struct
                                        {

-                                               uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_*
+                                               uint8_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_*

                                                                                           *   masks. This value is updated each time \ref CDC_Device_USBTask() is called.
                                                                                           */
                                                                                           *   masks. This value is updated each time \ref CDC_Device_USBTask() is called.
                                                                                           */

-                                               uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_*
+                                               uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_*

                                                                                           *   masks - to notify the host of changes to these values, call the
                                                                                           *   \ref CDC_Device_SendControlLineStateChange() function.
                                                                                           */
                                        } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
 
                                                                                           *   masks - to notify the host of changes to these values, call the
                                                                                           *   \ref CDC_Device_SendControlLineStateChange() function.
                                                                                           */
                                        } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
 

-                                       struct
-                                       {
-                                               uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second. */
-                                               uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
-                                                                                         *   \ref CDC_LineEncodingFormats_t enum.
-                                                                                         */
-                                               uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
-                                                                                         *   \ref CDC_LineEncodingParity_t enum.
-                                                                                         */
-                                               uint8_t  DataBits; /**< Bits of data per character of the virtual serial port. */
-                                       } LineEncoding; /** Line encoding used in the virtual serial port, for the device's information. This is generally
-                                                        *  only used if the virtual serial port data is to be reconstructed on a physical UART.
-                                                        */             
+                                       CDC_LineEncoding_t LineEncoding; /** Line encoding used in the virtual serial port, for the device's information.
+                                                                         *  This is generally only used if the virtual serial port data is to be
+                                                                         *  reconstructed on a physical UART.
+                                                                         */

                                } State; /**< State data for the USB class interface within the device. All elements in this section
                                          *   are reset to their defaults when the interface is enumerated.
                                          */
                        } USB_ClassInfo_CDC_Device_t;
                                } State; /**< State data for the USB class interface within the device. All elements in this section
                                          *   are reset to their defaults when the interface is enumerated.
                                          */
                        } USB_ClassInfo_CDC_Device_t;

-               
-               /* Function Prototypes: */              
+
+               /* Function Prototypes: */

                        /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
                         *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
                         *  the given CDC interface is selected.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *
                        /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library
                         *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
                         *  the given CDC interface is selected.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *

-                        *  \return Boolean true if the endpoints were successfully configured, false otherwise.
+                        *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.

                         */
                        bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Processes incoming control requests from the host, that are directed to the given CDC class interface. This should be
                         */
                        bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Processes incoming control requests from the host, that are directed to the given CDC class interface. This should be

-                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.
+                        *  linked to the library \ref EVENT_USB_Device_ControlRequest() event.

                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         */
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         */


@@ -179,11 +169,11 @@
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         */
                        void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         */
                        void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

-                       
+

                        /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
                         *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
                         *  user program by declaring a handler function with the same name and parameters listed here. The new control line states
                        /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a
                         *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the
                         *  user program by declaring a handler function with the same name and parameters listed here. The new control line states

-                        *  are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as
+                        *  are available in the State.ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as

                         *  a mask of CDC_CONTROL_LINE_OUT_* masks.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *  a mask of CDC_CONTROL_LINE_OUT_* masks.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.


@@ -199,30 +189,46 @@
                        void EVENT_CDC_Device_BreakSent(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
                                                        const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
 
                        void EVENT_CDC_Device_BreakSent(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
                                                        const uint8_t Duration) ATTR_NON_NULL_PTR_ARG(1);
 

-                       /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the
-                        *  string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the
-                        *  \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be 
-                        *  packed into a single endpoint packet, increasing data throughput.
+                       /** Sends a given data buffer to the attached USB host, if connected. If a host is not connected when the function is
+                        *  called, the string is discarded. Bytes will be queued for transmission to the host until either the endpoint bank
+                        *  becomes full, or the \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows
+                        *  for multiple bytes to be packed into a single endpoint packet, increasing data throughput.
+                        *
+                        *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or
+                        *       the call will fail.
+                        *
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+                        *  \param[in]     Buffer            Pointer to a buffer containing the data to send to the device.
+                        *  \param[in]     Length            Length of the data to send to the host.
+                        *
+                        *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
+                        */
+                       uint8_t CDC_Device_SendData(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
+                                                   const char* const Buffer,
+                                                   const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+
+                       /** Sends a given null terminated string to the attached USB host, if connected. If a host is not connected when
+                        *  the function is called, the string is discarded. Bytes will be queued for transmission to the host until either
+                        *  the endpoint bank becomes full, or the \ref CDC_Device_Flush() function is called to flush the pending data to
+                        *  the host. This allows for multiple bytes to be packed into a single endpoint packet, increasing data throughput.

                         *
                         *

-                        *  \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or

                         *       the call will fail.
                         *
                         *       the call will fail.
                         *

-                        *  \param[in,out]   CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
-                        *  \param[in]       Data              Pointer to the string to send to the host.
-                        *  \param[in]       Length            Size in bytes of the string to send to the host.
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
+                        *  \param[in]     String            Pointer to the null terminated string to send to the host.

                         *
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
                         */
                        uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
                         *
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
                         */
                        uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,

-                                                     char* const Data,
-                                                     const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
-                       
+                                                     const char* const String) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+

                        /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
                         *  byte is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the
                        /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the
                         *  byte is discarded. Bytes will be queued for transmission to the host until either the endpoint bank becomes full, or the

-                        *  \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be 
+                        *  \ref CDC_Device_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be

                         *  packed into a single endpoint packet, increasing data throughput.
                         *
                         *  packed into a single endpoint packet, increasing data throughput.
                         *

-                        *  \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or

                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.


@@ -232,10 +238,13 @@
                         */
                        uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
                                                    const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);
                         */
                        uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
                                                    const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);

-                       
-                       /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.
+
+                       /** Determines the number of bytes received by the CDC interface from the host, waiting to be read. This indicates the number
+                        *  of bytes in the OUT endpoint bank only, and thus the number of calls to \ref CDC_Device_ReceiveByte() which are guaranteed to
+                        *  succeed immediately. If multiple bytes are to be received, they should be buffered by the user application, as the endpoint
+                        *  bank will not be released back to the USB controller until all bytes are read.

                         *
                         *

-                        *  \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or

                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.


@@ -243,23 +252,24 @@
                         *  \return Total number of buffered bytes received from the host.
                         */
                        uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
                         *  \return Total number of buffered bytes received from the host.
                         */
                        uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

-                       
+

                        /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function
                        /** Reads a byte of data from the host. If no data is waiting to be read of if a USB host is not connected, the function

-                        *  returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data
-                        *  underflow occurs.
+                        *  returns a negative value. The \ref CDC_Device_BytesReceived() function may be queried in advance to determine how many
+                        *  bytes are currently buffered in the CDC interface's data receive endpoint bank, and thus how many repeated calls to this
+                        *  function which are guaranteed to succeed.

                         *
                         *

-                        *  \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or

                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *
                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *

-                        *  \return Next received byte from the host, or 0 if no data received.
+                        *  \return Next received byte from the host, or a negative value if no data received.

                         */
                         */

-                       uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
-                       
+                       int16_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+

                        /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
                         *
                        /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.
                         *

-                        *  \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or

                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.


@@ -267,13 +277,13 @@
                         *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
                         */
                        uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
                         *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
                         */
                        uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

-                       
+

                        /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial
                         *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist
                        /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial
                         *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist

-                        *  until they are cleared via a second notification. This should be called each time the CDC class driver's 
+                        *  until they are cleared via a second notification. This should be called each time the CDC class driver's

                         *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
                         *
                         *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.
                         *

-                        *  \pre This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
+                        *  \pre This function must only be called when the Device state machine is in the \ref DEVICE_STATE_Configured state or

                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *       the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.


@@ -281,16 +291,19 @@
                        void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_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
                        void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_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 <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created
+                        *  functions in the standard <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
                         *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may
                         *  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
                         *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may

-                        *  be used when the read data is processed byte-per-bye (via getc()) or when the user application will implement its own
+                        *  be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own

                         *  line buffering.
                         *
                         *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
                         *        to the given CDC interface.
                         *  line buffering.
                         *
                         *  \note The created stream can be given as stdout if desired to direct the standard output from all <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.
                         *
                         *  \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.


@@ -298,9 +311,11 @@
                        void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
                                                     FILE* const Stream) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 
                        void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo,
                                                     FILE* const Stream) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 

-                       /** Identical to CDC_Device_CreateStream(), except that reads are blocking until the calling stream function terminates
+                       /** Identical to \ref CDC_Device_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.
                         *
                         *  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.
                         */
                         *  \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.
                         */


@@ -310,13 +325,16 @@
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */

-                       #if defined(__INCLUDE_FROM_CDC_CLASS_DEVICE_C)
+                       #if defined(__INCLUDE_FROM_CDC_DEVICE_C)
+                               #if defined(FDEV_SETUP_STREAM)

                                static int CDC_Device_putchar(char c,
                                                              FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
                                static int CDC_Device_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
                                static int CDC_Device_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
                                static int CDC_Device_putchar(char c,
                                                              FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
                                static int CDC_Device_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
                                static int CDC_Device_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);

+                               #endif
+
+                               void CDC_Device_Event_Stub(void) ATTR_CONST;

                                
                                

-                               void CDC_Device_Event_Stub(void);

                                void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
                                                                          ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
                                void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
                                void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)
                                                                          ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);
                                void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)


@@ -327,12 +345,13 @@
                        #endif
 
        #endif
                        #endif
 
        #endif

-       
+

        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
                #endif

-               
+

 #endif
 
 /** @} */
 #endif
 
 /** @} */

+