Spell checked non-source documentation pages.
[pub/lufa.git] / Demos / Device / USBtoSerial / USBtoSerial.c
index c7c9e4b..1d238aa 100644 (file)
 \r
 #include "USBtoSerial.h"\r
 \r
-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName,    "LUFA USB RS232 App");\r
-BUTTLOADTAG(BuildTime,   __TIME__);\r
-BUTTLOADTAG(BuildDate,   __DATE__);\r
-BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
-\r
 /* Scheduler Task List */\r
 TASK_LIST\r
 {\r
@@ -79,7 +73,7 @@ int main(void)
        LEDs_Init();\r
        ReconfigureUSART();\r
        \r
-       /* Ringbuffer Initialization */\r
+       /* Ring buffer Initialization */\r
        Buffer_Initialize(&Rx_Buffer);\r
        Buffer_Initialize(&Tx_Buffer);\r
        \r
@@ -165,13 +159,13 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
                        if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {       \r
                                /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSetupReceived();\r
+                               Endpoint_ClearControlSETUP();\r
 \r
                                /* Write the line coding data to the control endpoint */\r
                                Endpoint_Write_Control_Stream_LE(LineCodingData, sizeof(LineCoding));\r
                                \r
                                /* Finalize the stream transfer to send the last packet or clear the host abort */\r
-                               Endpoint_ClearSetupOUT();\r
+                               Endpoint_ClearControlOUT();\r
                        }\r
                        \r
                        break;\r
@@ -179,13 +173,13 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
                        if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
                                /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSetupReceived();\r
+                               Endpoint_ClearControlSETUP();\r
 \r
                                /* Read the line coding data in from the host into the global struct */\r
                                Endpoint_Read_Control_Stream_LE(LineCodingData, sizeof(LineCoding));\r
 \r
                                /* Finalize the stream transfer to clear the last packet from the host */\r
-                               Endpoint_ClearSetupIN();\r
+                               Endpoint_ClearControlIN();\r
                                \r
                                /* Reconfigure the USART with the new settings */\r
                                ReconfigureUSART();\r
@@ -207,11 +201,11 @@ EVENT_HANDLER(USB_UnhandledControlPacket)
 #endif\r
                                \r
                                /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSetupReceived();\r
+                               Endpoint_ClearControlSETUP();\r
                                \r
                                /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsSetupINReady()));\r
-                               Endpoint_ClearSetupIN();\r
+                               while (!(Endpoint_IsINReady()));\r
+                               Endpoint_ClearControlIN();\r
                        }\r
        \r
                        break;\r
@@ -244,26 +238,27 @@ TASK(CDC_Task)
                Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPNUM);\r
                Endpoint_Write_Stream_LE(&Notification, sizeof(Notification));\r
                Endpoint_Write_Stream_LE(&LineStateMask, sizeof(LineStateMask));\r
-               Endpoint_ClearCurrentBank();\r
+               Endpoint_ClearIN();\r
 #endif\r
 \r
                /* Select the Serial Rx Endpoint */\r
                Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
                \r
-               if (Endpoint_ReadWriteAllowed())\r
+               if (Endpoint_IsOUTReceived())\r
                {\r
-                       /* Read the received data endpoint into the transmission buffer */\r
-                       while (Endpoint_BytesInEndpoint())\r
+                       /* Read the bytes in from the endpoint into the buffer while space is available */\r
+                       while (Endpoint_BytesInEndpoint() && (BUFF_STATICSIZE - Rx_Buffer.Elements))\r
                        {\r
-                               /* Wait until the buffer has space for a new character */\r
-                               while (!((BUFF_STATICSIZE - Rx_Buffer.Elements)));\r
-                       \r
                                /* Store each character from the endpoint */\r
                                Buffer_StoreElement(&Rx_Buffer, Endpoint_Read_Byte());\r
                        }\r
                        \r
-                       /* Clear the endpoint buffer */\r
-                       Endpoint_ClearCurrentBank();\r
+                       /* Check to see if all bytes in the current packet have been read */\r
+                       if (!(Endpoint_BytesInEndpoint()))\r
+                       {\r
+                               /* Clear the endpoint buffer */\r
+                               Endpoint_ClearOUT();\r
+                       }\r
                }\r
                \r
                /* Check if Rx buffer contains data */\r
@@ -284,26 +279,30 @@ TASK(CDC_Task)
                if (Tx_Buffer.Elements)\r
                {\r
                        /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
-                       while (!(Endpoint_ReadWriteAllowed()));\r
-                       \r
-                       /* Check before sending the data if the endpoint is completely full */\r
-                       bool IsFull = (Endpoint_BytesInEndpoint() == CDC_TXRX_EPSIZE);\r
+                       while (!(Endpoint_IsReadWriteAllowed()));\r
                        \r
-                       /* Write the transmission buffer contents to the received data endpoint */\r
+                       /* Write the bytes from the buffer to the endpoint while space is available */\r
                        while (Tx_Buffer.Elements && (Endpoint_BytesInEndpoint() < CDC_TXRX_EPSIZE))\r
-                         Endpoint_Write_Byte(Buffer_GetElement(&Tx_Buffer));\r
+                       {\r
+                               /* Write each byte retreived from the buffer to the endpoint */\r
+                               Endpoint_Write_Byte(Buffer_GetElement(&Tx_Buffer));\r
+                       }\r
+                       \r
+                       /* Remember if the packet to send completely fills the endpoint */\r
+                       bool IsFull = (Endpoint_BytesInEndpoint() == CDC_TXRX_EPSIZE);\r
                        \r
                        /* Send the data */\r
-                       Endpoint_ClearCurrentBank();\r
+                       Endpoint_ClearIN();\r
 \r
-                       /* If a full endpoint was sent, we need to send an empty packet afterwards to terminate the transfer */\r
-                       if (IsFull)\r
+                       /* If no more data to send and the last packet filled the endpoint, send an empty packet to release\r
+                        * the buffer on the receiver (otherwise all data will be cached until a non-full packet is received) */\r
+                       if (IsFull && !(Tx_Buffer.Elements))\r
                        {\r
                                /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
-                               while (!(Endpoint_ReadWriteAllowed()));\r
+                               while (!(Endpoint_IsReadWriteAllowed()));\r
 \r
                                /* Send an empty packet to terminate the transfer */\r
-                               Endpoint_ClearCurrentBank();\r
+                               Endpoint_ClearIN();\r
                        }\r
                }\r
        }\r