Update ENDPOINT_EPNUM_MASK to be 0x0F, the maximum possible USB endpoint number withi...

[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 9eb7b48..b1eeb41 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -118,13 +118,13 @@
                                {
                                        struct
                                        {
                                {
                                        struct
                                        {

-                                               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.
-                                                                                          */
-                                               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.
-                                                                                          */
+                                               uint16_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.
+                                                                                           */
+                                               uint16_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. */
 
                                        CDC_LineEncoding_t LineEncoding; /** Line encoding used in the virtual serial port, for the device's information.
                                        } ControlLineStates; /**< Current states of the virtual serial port's control lines between the device and host. */
 
                                        CDC_LineEncoding_t LineEncoding; /** Line encoding used in the virtual serial port, for the device's information.


@@ -141,10 +141,6 @@
                         *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
                         *  the given CDC interface is selected.
                         *
                         *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing
                         *  the given CDC interface is selected.
                         *

-                        *  \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other
-                        *        interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes
-                        *        within a single interface is allowed, but no two interfaces of any type have have interleaved endpoint indexes.
-                        *

                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *
                         *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *
                         *  \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.


@@ -177,7 +173,7 @@
                        /** 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.


@@ -295,7 +291,7 @@
                        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 \c FILE stream as a destination (e.g. \c 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
                         *  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


@@ -305,6 +301,9 @@
                         *
                         *  \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.
                         *
                         *  \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.


@@ -315,6 +314,8 @@
                        /** 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.
                         *
                        /** 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.
                         *

+                        *  \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.
                         */


@@ -325,12 +326,15 @@
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_CDC_DEVICE_C)
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */
                        #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) ATTR_CONST;

+                               

                                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)