Finish initial draft of the Host Mode HID Class driver.
[pub/USBasp.git] / Demos / Device / LowLevel / USBtoSerial / USBtoSerial.c
index ee4208f..92449a6 100644 (file)
  *  These values are set by the host via a class-specific request, and the physical USART should be reconfigured to match the\r
  *  new settings each time they are changed by the host.\r
  */\r
-CDC_Line_Coding_t LineCoding = { .BaudRateBPS = 9600,\r
-                                 .CharFormat  = OneStopBit,\r
-                                 .ParityType  = Parity_None,\r
-                                 .DataBits    = 8            };\r
+CDC_Line_Coding_t LineEncoding = { .BaudRateBPS = 0,\r
+                                   .CharFormat  = OneStopBit,\r
+                                   .ParityType  = Parity_None,\r
+                                   .DataBits    = 8            };\r
 \r
 /** Ring (circular) buffer to hold the RX data - data from the host to the attached device on the serial port. */\r
 RingBuff_t Rx_Buffer;\r
@@ -81,15 +81,15 @@ void SetupHardware(void)
        clock_prescale_set(clock_div_1);\r
 \r
        /* Hardware Initialization */\r
+       Serial_Init(9600, false);\r
        LEDs_Init();\r
-       ReconfigureUSART();\r
-       USB_Init();     \r
+       USB_Init();\r
 }\r
 \r
 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
  *  starts the library USB task to begin the enumeration and USB management process.\r
  */\r
-void EVENT_USB_Connect(void)\r
+void EVENT_USB_Device_Connect(void)\r
 {\r
        /* Indicate USB enumerating */\r
        LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
@@ -98,7 +98,7 @@ void EVENT_USB_Connect(void)
 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
  *  the status LEDs and stops the USB management and CDC management tasks.\r
  */\r
-void EVENT_USB_Disconnect(void)\r
+void EVENT_USB_Device_Disconnect(void)\r
 {      \r
        /* Reset Tx and Rx buffers, device disconnected */\r
        Buffer_Initialize(&Rx_Buffer);\r
@@ -111,33 +111,43 @@ void EVENT_USB_Disconnect(void)
 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration\r
  *  of the USB device after enumeration - the device endpoints are configured and the CDC management task started.\r
  */\r
-void EVENT_USB_ConfigurationChanged(void)\r
+void EVENT_USB_Device_ConfigurationChanged(void)\r
 {\r
-       /* Setup CDC Notification, Rx and Tx Endpoints */\r
-       Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
+       /* Indicate USB connected and ready */\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
 \r
-       Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
+       /* Setup CDC Notification, Rx and Tx Endpoints */\r
+       if (!(Endpoint_ConfigureEndpoint(CDC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
+                                            ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
+                                        ENDPOINT_BANK_SINGLE)))\r
+       {\r
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       }\r
+       \r
+       if (!(Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,\r
+                                            ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
+                                        ENDPOINT_BANK_SINGLE)))\r
+       {\r
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       }                                                          \r
 \r
-       Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
+       if (!(Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,\r
+                                            ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
+                                        ENDPOINT_BANK_SINGLE)))\r
+       {\r
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       }\r
 \r
-       /* Indicate USB connected and ready */\r
-       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+       /* Reset line encoding baud rate so that the host knows to send new values */\r
+       LineEncoding.BaudRateBPS = 0;\r
 }\r
 \r
-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
+/** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific\r
  *  control requests that are not handled internally by the USB library (including the CDC control commands,\r
  *  which are all issued via the control endpoint), so that they can be handled appropriately for the application.\r
  */\r
-void EVENT_USB_UnhandledControlPacket(void)\r
+void EVENT_USB_Device_UnhandledControlRequest(void)\r
 {\r
-       uint8_t* LineCodingData = (uint8_t*)&LineCoding;\r
-\r
        /* Process CDC specific control requests */\r
        switch (USB_ControlRequest.bRequest)\r
        {\r
@@ -148,7 +158,7 @@ void EVENT_USB_UnhandledControlPacket(void)
                                Endpoint_ClearSETUP();\r
 \r
                                /* Write the line coding data to the control endpoint */\r
-                               Endpoint_Write_Control_Stream_LE(LineCodingData, sizeof(LineCoding));\r
+                               Endpoint_Write_Control_Stream_LE(&LineEncoding, sizeof(LineEncoding));\r
                                \r
                                /* Finalize the stream transfer to send the last packet or clear the host abort */\r
                                Endpoint_ClearOUT();\r
@@ -162,7 +172,7 @@ void EVENT_USB_UnhandledControlPacket(void)
                                Endpoint_ClearSETUP();\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
+                               Endpoint_Read_Control_Stream_LE(&LineEncoding, sizeof(LineEncoding));\r
 \r
                                /* Finalize the stream transfer to clear the last packet from the host */\r
                                Endpoint_ClearIN();\r
@@ -183,9 +193,7 @@ void EVENT_USB_UnhandledControlPacket(void)
                                                 CONTROL_LINE_OUT_* masks to determine the RTS and DTR line states using the following code:\r
                                */\r
 \r
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsINReady()));\r
-                               Endpoint_ClearIN();\r
+                               Endpoint_ClearStatusStage();\r
                        }\r
        \r
                        break;\r
@@ -195,89 +203,90 @@ void EVENT_USB_UnhandledControlPacket(void)
 /** Task to manage CDC data transmission and reception to and from the host, from and to the physical USART. */\r
 void CDC_Task(void)\r
 {\r
-       if (USB_IsConnected)\r
-       {\r
+       /* Device must be connected and configured for the task to run */\r
+       if (USB_DeviceState != DEVICE_STATE_Configured)\r
+         return;\r
+         \r
 #if 0\r
-               /* NOTE: Here you can use the notification endpoint to send back line state changes to the host, for the special RS-232\r
-                                handshake signal lines (and some error states), via the CONTROL_LINE_IN_* masks and the following code:\r
-               */\r
+       /* NOTE: Here you can use the notification endpoint to send back line state changes to the host, for the special RS-232\r
+                        handshake signal lines (and some error states), via the CONTROL_LINE_IN_* masks and the following code:\r
+       */\r
 \r
-               USB_Notification_Header_t Notification = (USB_Notification_Header_t)\r
-                       {\r
-                               .NotificationType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                               .Notification     = NOTIF_SerialState,\r
-                               .wValue           = 0,\r
-                               .wIndex           = 0,\r
-                               .wLength          = sizeof(uint16_t),\r
-                       };\r
-                       \r
-               uint16_t LineStateMask;\r
-               \r
-               // Set LineStateMask here to a mask of CONTROL_LINE_IN_* masks to set the input handshake line states to send to the host\r
+       USB_Notification_Header_t Notification = (USB_Notification_Header_t)\r
+               {\r
+                       .NotificationType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
+                       .Notification     = NOTIF_SerialState,\r
+                       .wValue           = 0,\r
+                       .wIndex           = 0,\r
+                       .wLength          = sizeof(uint16_t),\r
+               };\r
                \r
-               Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPNUM);\r
-               Endpoint_Write_Stream_LE(&Notification, sizeof(Notification));\r
-               Endpoint_Write_Stream_LE(&LineStateMask, sizeof(LineStateMask));\r
-               Endpoint_ClearIN();\r
+       uint16_t LineStateMask;\r
+       \r
+       // Set LineStateMask here to a mask of CONTROL_LINE_IN_* masks to set the input handshake line states to send to the host\r
+       \r
+       Endpoint_SelectEndpoint(CDC_NOTIFICATION_EPNUM);\r
+       Endpoint_Write_Stream_LE(&Notification, sizeof(Notification));\r
+       Endpoint_Write_Stream_LE(&LineStateMask, sizeof(LineStateMask));\r
+       Endpoint_ClearIN();\r
 #endif\r
 \r
-               /* Select the Serial Rx Endpoint */\r
-               Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
-               \r
-               /* Check to see if a packet has been received from the host */\r
-               if (Endpoint_IsOUTReceived())\r
+       /* Select the Serial Rx Endpoint */\r
+       Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
+       \r
+       /* Check to see if a packet has been received from the host */\r
+       if (Endpoint_IsOUTReceived())\r
+       {\r
+               /* Read the bytes in from the endpoint into the buffer while space is available */\r
+               while (Endpoint_BytesInEndpoint() && (Rx_Buffer.Elements != BUFF_STATICSIZE))\r
                {\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
-                               /* Store each character from the endpoint */\r
-                               Buffer_StoreElement(&Rx_Buffer, Endpoint_Read_Byte());\r
-                       }\r
-                       \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
+                       /* Store each character from the endpoint */\r
+                       Buffer_StoreElement(&Rx_Buffer, Endpoint_Read_Byte());\r
                }\r
                \r
-               /* Check if Rx buffer contains data - if so, send it */\r
-               if (Rx_Buffer.Elements)\r
-                 Serial_TxByte(Buffer_GetElement(&Rx_Buffer));\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 - if so, send it */\r
+       if (Rx_Buffer.Elements)\r
+         Serial_TxByte(Buffer_GetElement(&Rx_Buffer));\r
+\r
+       /* Select the Serial Tx Endpoint */\r
+       Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
 \r
-               /* Select the Serial Tx Endpoint */\r
-               Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r
+       /* Check if the Tx buffer contains anything to be sent to the host */\r
+       if ((Tx_Buffer.Elements) && LineEncoding.BaudRateBPS)\r
+       {\r
+               /* Wait until Serial Tx Endpoint Ready for Read/Write */\r
+               Endpoint_WaitUntilReady();\r
+               \r
+               /* Write the bytes from the buffer to the endpoint while space is available */\r
+               while (Tx_Buffer.Elements && Endpoint_IsReadWriteAllowed())\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_ClearIN();\r
 \r
-               /* Check if the Tx buffer contains anything to be sent to the host */\r
-               if (Tx_Buffer.Elements)\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_IsReadWriteAllowed()));\r
-                       \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
-                       {\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_WaitUntilReady();\r
+                               \r
+                       /* Send an empty packet to terminate the transfer */\r
                        Endpoint_ClearIN();\r
-\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_IsReadWriteAllowed()));\r
-\r
-                               /* Send an empty packet to terminate the transfer */\r
-                               Endpoint_ClearIN();\r
-                       }\r
                }\r
        }\r
 }\r
@@ -287,12 +296,11 @@ void CDC_Task(void)
  */\r
 ISR(USART1_RX_vect, ISR_BLOCK)\r
 {\r
+       uint8_t ReceivedByte = UDR1;\r
+\r
        /* Only store received characters if the USB interface is connected */\r
-       if (USB_IsConnected)\r
-       {\r
-               /* Character received, store it into the buffer */\r
-               Buffer_StoreElement(&Tx_Buffer, UDR1);\r
-       }\r
+       if ((USB_DeviceState == DEVICE_STATE_Configured) && LineEncoding.BaudRateBPS)\r
+         Buffer_StoreElement(&Tx_Buffer, ReceivedByte);\r
 }\r
 \r
 /** Reconfigures the USART to match the current serial port settings issued by the host as closely as possible. */\r
@@ -301,21 +309,21 @@ void ReconfigureUSART(void)
        uint8_t ConfigMask = 0;\r
 \r
        /* Determine parity - non odd/even parity mode defaults to no parity */\r
-       if (LineCoding.ParityType == Parity_Odd)\r
+       if (LineEncoding.ParityType == Parity_Odd)\r
          ConfigMask = ((1 << UPM11) | (1 << UPM10));\r
-       else if (LineCoding.ParityType == Parity_Even)\r
+       else if (LineEncoding.ParityType == Parity_Even)\r
          ConfigMask = (1 << UPM11);\r
 \r
        /* Determine stop bits - 1.5 stop bits is set as 1 stop bit due to hardware limitations */\r
-       if (LineCoding.CharFormat == TwoStopBits)\r
+       if (LineEncoding.CharFormat == TwoStopBits)\r
          ConfigMask |= (1 << USBS1);\r
 \r
        /* Determine data size - 5, 6, 7, or 8 bits are supported */\r
-       if (LineCoding.DataBits == 6)\r
+       if (LineEncoding.DataBits == 6)\r
          ConfigMask |= (1 << UCSZ10);\r
-       else if (LineCoding.DataBits == 7)\r
+       else if (LineEncoding.DataBits == 7)\r
          ConfigMask |= (1 << UCSZ11);\r
-       else if (LineCoding.DataBits == 8)\r
+       else if (LineEncoding.DataBits == 8)\r
          ConfigMask |= ((1 << UCSZ11) | (1 << UCSZ10));\r
        \r
        /* Enable double speed, gives better error percentages at 8MHz */\r
@@ -328,5 +336,5 @@ void ReconfigureUSART(void)
        UCSR1C = ConfigMask;\r
        \r
        /* Set the USART baud rate register to the desired baud rate value */\r
-       UBRR1  = SERIAL_2X_UBBRVAL((uint16_t)LineCoding.BaudRateBPS);\r
+       UBRR1  = SERIAL_2X_UBBRVAL((uint16_t)LineEncoding.BaudRateBPS);\r
 }\r