Speed up bit-banged USART code in the AVRISP project.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / CDC.h
index 0ee24be..1873f55 100644 (file)
                                        uint16_t DataINPipeSize; /**< Size in bytes of the CDC interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the CDC interface's OUT data pipe */\r
                                        uint16_t NotificationPipeSize;  /**< Size in bytes of the CDC interface's IN notification pipe, if used */\r
+                                       \r
+                                       bool BidirectionalDataEndpoints; /**< Indicates if the attached CDC interface uses bidirectional data endpoints,\r
+                                                                         *   and this has only the IN pipe configured (with \ref Pipe_SetPipeToken()\r
+                                                                         *   used to switch the pipe's direction)\r
+                                                                         */\r
 \r
                                        struct\r
                                        {\r
                         *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum\r
                         */\r
                        uint8_t CDC_Host_ConfigurePipes(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, uint16_t ConfigDescriptorSize,\r
-                                                       void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(13);\r
+                                                       void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r
                        \r
                        /** Sets the line encoding for the attached device's virtual serial port. This should be called when the LineEncoding\r
                         *  values of the interface have been changed to push the new settings to the USB device.\r
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
                         */\r
-                       uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* Data, const uint16_t Length) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                       uint8_t CDC_Host_SendString(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo, char* 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 device, if connected. If a host is not connected when the function is called, the\r
                         *  byte is discarded.\r
                         */\r
                        uint8_t CDC_Host_ReceiveByte(USB_ClassInfo_CDC_Host_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 host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t CDC_Host_Flush(USB_ClassInfo_CDC_Host_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).\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
                         *  \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
                        void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);\r
 \r
+                       /** Identical to CDC_Host_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
+                       void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);\r
+\r
                        /** CDC class driver event for a control line state change on a CDC host interface. This event fires each time the device notifies\r
                         *  the host of a control line state change (containing the virtual serial control line states, such as DCD) and may be hooked in the\r
                         *  user program by declaring a handler function with the same name and parameters listed here. The new control line states\r
                        #if defined(INCLUDE_FROM_CDC_CLASS_HOST_C)\r
                                static int CDC_Host_putchar(char c, FILE* Stream);\r
                                static int CDC_Host_getchar(FILE* Stream);\r
+                               static int CDC_Host_getchar_Blocking(FILE* Stream);\r
 \r
                                void CDC_Host_Event_Stub(void);\r
                                void EVENT_CDC_Host_ControLineStateChanged(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo)\r