Ooops - TeensyHID bootloader makefile should use a 16MHz FCPU, not 8MHz.

[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 17e9b35..5cd3aaf 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -48,6 +48,7 @@
                #include "../../USB.h"\r
                #include "../Common/CDC.h"\r
 \r
                #include "../../USB.h"\r
                #include "../Common/CDC.h"\r
 \r

+               #include <stdio.h>\r

                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r
                #include <string.h>\r
 \r
        /* Enable C linkage for C++ Compilers: */\r


@@ -69,12 +70,15 @@
 \r
                                        uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */\r
                                        uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */\r
 \r
                                        uint8_t  DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint */\r
                                        uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint */\r

+                                       bool     DataINEndpointDoubleBank; /** Indicates if the CDC interface's IN data endpoint should use double banking */\r

 \r
                                        uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */\r
                                        uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */\r
 \r
                                        uint8_t  DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint */\r
                                        uint16_t DataOUTEndpointSize;  /**< Size in bytes of the CDC interface's OUT data endpoint */\r

+                                       bool     DataOUTEndpointDoubleBank; /** Indicates if the CDC interface's OUT data endpoint should use double banking */\r

 \r
                                        uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */\r
                                        uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r
 \r
                                        uint8_t  NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used */\r
                                        uint16_t NotificationEndpointSize;  /**< Size in bytes of the CDC interface's IN notification endpoint, if used */\r

+                                       bool     NotificationEndpointDoubleBank; /** Indicates if the CDC interface's notification endpoint should use double banking */\r

                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                           */\r
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                           */\r


@@ -102,44 +106,43 @@
                                                uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */\r
                                        } LineEncoding;                 \r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                                uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */\r
                                        } LineEncoding;                 \r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r

-                                         *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
-                                         *   the interface is enumerated.\r
+                                         *   are reset to their defaults when the interface is enumerated.\r

                                          */\r
                        } USB_ClassInfo_CDC_Device_t;\r
                \r
                /* Function Prototypes: */              \r
                        /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library\r
                                          */\r
                        } USB_ClassInfo_CDC_Device_t;\r
                \r
                /* Function Prototypes: */              \r
                        /** Configures the endpoints of a given CDC interface, ready for use. This should be linked to the library\r

-                        *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration containing the\r
-                        *  given CDC interface is selected.\r
+                        *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration containing\r
+                        *  the given CDC interface is selected.\r

                         *\r
                         *\r

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

                         *\r
                         *\r

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

                         */\r
                         */\r

-                       bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\r
+                       bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
 \r

-                       /** Processes incomming control requests from the host, that are directed to the given CDC class interface. This should be\r
-                        *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+                       /** Processes incoming control requests from the host, that are directed to the given CDC class interface. This should be\r
+                        *  linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r

                         *\r
                         *\r

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

                         */\r
                         */\r

-                       void CDC_Device_ProcessControlPacket(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\r
+                       void CDC_Device_ProcessControlRequest(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
                        /** General management task for a given CDC class interface, required for the correct operation of the interface. This should\r
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
                         *\r
 \r
                        /** General management task for a given CDC class interface, required for the correct operation of the interface. This should\r
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
                         *\r

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

                         */\r
                         */\r

-                       void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\r
+                       void CDC_Device_USBTask(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

 \r
                        /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a\r
                         *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the\r
                         *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding\r
                         *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.\r
                         *\r
 \r
                        /** CDC class driver event for a line encoding change on a CDC interface. This event fires each time the host requests a\r
                         *  line encoding change (containing the serial parity, baud and other configuration information) and may be hooked in the\r
                         *  user program by declaring a handler function with the same name and parameters listed here. The new line encoding\r
                         *  settings are available in the LineEncoding structure inside the CDC interface structure passed as a parameter.\r
                         *\r

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

                         */\r
                         */\r

-                       void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\r
+                       void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a\r
                         *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the\r
                        \r
                        /** CDC class driver event for a control line state change on a CDC interface. This event fires each time the host requests a\r
                         *  control line state change (containing the virtual serial control line states, such as DTR) and may be hooked in the\r


@@ -147,63 +150,105 @@
                         *  are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as\r
                         *  a mask of CDC_CONTROL_LINE_OUT_* masks.\r
                         *\r
                         *  are available in the ControlLineStates.HostToDevice value inside the CDC interface structure passed as a parameter, set as\r
                         *  a mask of CDC_CONTROL_LINE_OUT_* masks.\r
                         *\r

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

 \r
                        /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
                         *  string is discarded.\r
                         *\r
 \r
                        /** Sends a given string to the attached USB host, if connected. If a host is not connected when the function is called, the\r
                         *  string is discarded.\r
                         *\r

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

                         *  \param[in] Data  Pointer to the string to send to the host\r
                         *  \param[in] Length  Size in bytes of the string to send to the host\r
                         *  \param[in] Data  Pointer to the string to send to the host\r
                         *  \param[in] Length  Size in bytes of the string to send to the host\r

+                        *\r
+                        *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum\r

                         */\r
                         */\r

-                       void CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const Data, const uint16_t Length);\r
+                       uint8_t CDC_Device_SendString(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, char* const Data, const uint16_t Length)\r
+                                                     ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r

                        \r
                        /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the\r
                         *  byte is discarded.\r
                         *\r
                        \r
                        /** Sends a given byte to the attached USB host, if connected. If a host is not connected when the function is called, the\r
                         *  byte is discarded.\r
                         *\r

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

                         *  \param[in] Data  Byte of data to send to the host\r
                         *  \param[in] Data  Byte of data to send to the host\r

+                        *\r
+                        *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r

                         */\r
                         */\r

-                       void CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, const uint8_t Data);\r
+                       uint8_t CDC_Device_SendByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.\r
                         *\r
                        \r
                        /** Determines the number of bytes received by the CDC interface from the host, waiting to be read.\r
                         *\r

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

                         *\r
                         *  \return Total number of buffered bytes received from the host\r
                         */\r
                         *\r
                         *  \return Total number of buffered bytes received from the host\r
                         */\r

-                       uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\r
+                       uint16_t CDC_Device_BytesReceived(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        /** 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\r
                        \r
                        /** 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\r

-                        *  returns 0. The USB_CDC_BytesReceived() function should be queried before data is recieved to ensure that no data\r
+                        *  returns 0. The \ref CDC_Device_BytesReceived() function should be queried before data is received to ensure that no data\r

                         *  underflow occurs.\r
                         *\r
                         *  underflow occurs.\r
                         *\r

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

                         *\r
                         *  \return Next received byte from the host, or 0 if no data received\r
                         */\r
                         *\r
                         *  \return Next received byte from the host, or 0 if no data received\r
                         */\r

-                       uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\r
+                       uint8_t CDC_Device_ReceiveByte(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *\r
+                        *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Device_Flush(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial\r
                        \r
                        /** Sends a Serial Control Line State Change notification to the host. This should be called when the virtual serial\r

-                        *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notfications to the host. Line states persist\r
+                        *  control lines (DCD, DSR, etc.) have changed states, or to give BREAK notifications to the host. Line states persist\r

                         *  until they are cleared via a second notification. This should be called each time the CDC class driver's \r
                         *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.\r
                         *\r
                         *  until they are cleared via a second notification. This should be called each time the CDC class driver's \r
                         *  ControlLineStates.DeviceToHost value is updated to push the new states to the USB host.\r
                         *\r

-                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        */\r
+                       void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Creates a standard characer stream for the given CDC Device instance so that it can be used with all the regular\r
+                        *  functions in the avr-libc <stdio.h> library that accept a FILE stream as a destination (e.g. fprintf). The created\r
+                        *  stream is bidirectional and can be used for both input and output functions.\r
+                        *\r
+                        *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single\r
+                        *  fetch, as the endpoint will not be ready at some point in the transmission, aborting the transfer. However, this may\r
+                        *  be used when the read data is processed byte-per-bye (via getc()) or when the user application will implement its own\r
+                        *  line buffering.\r
+                        *\r
+                        *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions\r
+                        *        to the given CDC interface.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed\r
+                        */\r
+                       void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);\r
+\r
+                       /** Identical to CDC_Device_CreateStream(), except that reads are blocking until the calling stream function terminates\r
+                        *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.\r
+                        *\r
+                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state\r
+                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed\r

                         */\r
                         */\r

-                       void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo);\r
+                       void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);\r

 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_DEVICE_C)\r

+                               static int CDC_Device_putchar(char c, FILE* Stream);\r
+                               static int CDC_Device_getchar(FILE* Stream);\r
+                               static int CDC_Device_getchar_Blocking(FILE* Stream);\r
+                               \r

                                void CDC_Device_Event_Stub(void);\r
                                void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r
                                void CDC_Device_Event_Stub(void);\r
                                void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r

-                                                                                                                 ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);\r
+                                                                                                                 ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r

                                void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r
                                void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)\r

-                                                                                                                        ATTR_WEAK ATTR_ALIAS(CDC_Device_Event_Stub);\r
+                                                                                                                        ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub);\r

                        #endif\r
 \r
        #endif\r
                        #endif\r
 \r
        #endif\r