Commit of new class abstraction APIs for all device demos other than the MIDI demo...
[pub/USBasp.git] / Demos / Device / USBtoSerial / USBtoSerial.c
index 7cef565..7c89278 100644 (file)
 \r
 #include "USBtoSerial.h"\r
 \r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
-       { .Task = CDC_Task             , .TaskStatus = TASK_STOP },\r
-};\r
+RingBuff_t Rx_Buffer;\r
+RingBuff_t Tx_Buffer;\r
 \r
-/* Globals: */\r
-/** Contains the current baud rate and other settings of the virtual serial port.\r
- *\r
- *  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
+USB_ClassInfo_CDC_t VirtualSerial_CDC_Interface =\r
+       {\r
+               .ControlInterfaceNumber     = 0,\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
+               .DataINEndpointNumber       = CDC_TX_EPNUM,\r
+               .DataINEndpointSize         = CDC_TXRX_EPSIZE,\r
 \r
-/** Ring (circular) buffer to hold the TX data - data from the attached device on the serial port to the host. */\r
-RingBuff_t Tx_Buffer;\r
+               .DataOUTEndpointNumber      = CDC_RX_EPNUM,\r
+               .DataOUTEndpointSize        = CDC_TXRX_EPSIZE,\r
 \r
-/** Flag to indicate if the USART is currently transmitting data from the Rx_Buffer circular buffer. */\r
-volatile bool Transmitting = false;\r
+               .NotificationEndpointNumber = CDC_NOTIFICATION_EPNUM,\r
+               .NotificationEndpointSize   = CDC_NOTIFICATION_EPSIZE,\r
+       };\r
 \r
-/** Main program entry point. This routine configures the hardware required by the application, then\r
- *  starts the scheduler to run the application tasks.\r
- */\r
 int main(void)\r
 {\r
+       SetupHardware();\r
+       \r
+       Buffer_Initialize(&Rx_Buffer);\r
+       Buffer_Initialize(&Tx_Buffer);\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               for (uint8_t DataBytesRem = USB_CDC_BytesReceived(&VirtualSerial_CDC_Interface); DataBytesRem != 0; DataBytesRem--)\r
+               {\r
+                       if (!(BUFF_STATICSIZE - Rx_Buffer.Elements))\r
+                         break;\r
+                         \r
+                       Buffer_StoreElement(&Rx_Buffer, USB_CDC_ReceiveByte(&VirtualSerial_CDC_Interface));\r
+               }\r
+               \r
+               if (Tx_Buffer.Elements)\r
+                 USB_CDC_SendByte(&VirtualSerial_CDC_Interface, Buffer_GetElement(&Rx_Buffer));\r
+                 \r
+               if (Rx_Buffer.Elements)\r
+                 Serial_TxByte(Buffer_GetElement(&Rx_Buffer));\r
+               \r
+               USB_CDC_USBTask(&VirtualSerial_CDC_Interface);\r
+               USB_USBTask();\r
+       }\r
+}\r
+\r
+void SetupHardware(void)\r
+{\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
@@ -70,304 +87,61 @@ int main(void)
        clock_prescale_set(clock_div_1);\r
 \r
        /* Hardware Initialization */\r
+       Joystick_Init();\r
        LEDs_Init();\r
-       ReconfigureUSART();\r
-       \r
-       /* Ring buffer Initialization */\r
-       Buffer_Initialize(&Rx_Buffer);\r
-       Buffer_Initialize(&Tx_Buffer);\r
-       \r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-       \r
-       /* Initialize Scheduler so that it can be used */\r
-       Scheduler_Init();\r
-\r
-       /* Initialize USB Subsystem */\r
        USB_Init();\r
-\r
-       /* Scheduling - routine never returns, so put this last in the main function */\r
-       Scheduler_Start();\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
 {\r
-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-\r
-       /* Indicate USB enumerating */\r
-       UpdateStatus(Status_USBEnumerating);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
 }\r
 \r
-/** 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
 {\r
-       /* Stop running CDC and USB management tasks */\r
-       Scheduler_SetTaskMode(CDC_Task, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       \r
-       /* Reset Tx and Rx buffers, device disconnected */\r
-       Buffer_Initialize(&Rx_Buffer);\r
-       Buffer_Initialize(&Tx_Buffer);\r
-\r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
 }\r
 \r
-/** 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
 {\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
-\r
-       Endpoint_ConfigureEndpoint(CDC_TX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
 \r
-       Endpoint_ConfigureEndpoint(CDC_RX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Indicate USB connected and ready */\r
-       UpdateStatus(Status_USBReady);\r
-\r
-       /* Start CDC task */\r
-       Scheduler_SetTaskMode(CDC_Task, TASK_RUN);\r
+       if (!(USB_CDC_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r
 \r
-/** Event handler for the USB_UnhandledControlPacket 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
 {\r
-       uint8_t* LineCodingData = (uint8_t*)&LineCoding;\r
-\r
-       /* Process CDC specific control requests */\r
-       switch (USB_ControlRequest.bRequest)\r
-       {\r
-               case REQ_GetLineEncoding:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {       \r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSETUP();\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_ClearOUT();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_SetLineEncoding:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               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
-\r
-                               /* Finalize the stream transfer to clear the last packet from the host */\r
-                               Endpoint_ClearIN();\r
-                               \r
-                               /* Reconfigure the USART with the new settings */\r
-                               ReconfigureUSART();\r
-                       }\r
-       \r
-                       break;\r
-               case REQ_SetControlLineState:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {                               \r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               /* NOTE: Here you can read in the line state mask from the host, to get the current state of the output handshake\r
-                                        lines. The mask is read in from the wValue parameter in USB_ControlRequest, and can be masked against the\r
-                                                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
-                       }\r
-       \r
-                       break;\r
-       }\r
-}\r
-\r
-/** Task to manage CDC data transmission and reception to and from the host, from and to the physical USART. */\r
-TASK(CDC_Task)\r
-{\r
-       if (USB_IsConnected)\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
-\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
-               \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
-               {\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
-               }\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
-               /* Check if the Tx buffer contains anything to be sent to the host */\r
-               if (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_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
+       USB_CDC_ProcessControlPacket(&VirtualSerial_CDC_Interface);\r
 }\r
 \r
-/** ISR to handle the USART receive complete interrupt, fired each time the USART has received a character. This stores the received\r
- *  character into the Tx_Buffer circular buffer for later transmission to the host.\r
- */\r
 ISR(USART1_RX_vect, ISR_BLOCK)\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
+         Buffer_StoreElement(&Tx_Buffer, UDR1);\r
 }\r
 \r
-/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
- *  log to a serial port, or anything else that is suitable for status updates.\r
- *\r
- *  \param CurrentStatus  Current status of the system, from the USBtoSerial_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
-{\r
-       uint8_t LEDMask = LEDS_NO_LEDS;\r
-       \r
-       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
-       switch (CurrentStatus)\r
-       {\r
-               case Status_USBNotReady:\r
-                       LEDMask = (LEDS_LED1);\r
-                       break;\r
-               case Status_USBEnumerating:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
-                       break;\r
-               case Status_USBReady:\r
-                       LEDMask = (LEDS_LED2 | LEDS_LED4);\r
-                       break;\r
-       }\r
-       \r
-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-/** Reconfigures the USART to match the current serial port settings issued by the host as closely as possible. */\r
-void ReconfigureUSART(void)\r
+void EVENT_USB_CDC_LineEncodingChanged(USB_ClassInfo_CDC_t* CDCInterfaceInfo)\r
 {\r
        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 (CDCInterfaceInfo->LineEncoding.ParityType == Parity_Odd)\r
          ConfigMask = ((1 << UPM11) | (1 << UPM10));\r
-       else if (LineCoding.ParityType == Parity_Even)\r
+       else if (CDCInterfaceInfo->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 (CDCInterfaceInfo->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 (CDCInterfaceInfo->LineEncoding.DataBits == 6)\r
          ConfigMask |= (1 << UCSZ10);\r
-       else if (LineCoding.DataBits == 7)\r
+       else if (CDCInterfaceInfo->LineEncoding.DataBits == 7)\r
          ConfigMask |= (1 << UCSZ11);\r
-       else if (LineCoding.DataBits == 8)\r
+       else if (CDCInterfaceInfo->LineEncoding.DataBits == 8)\r
          ConfigMask |= ((1 << UCSZ11) | (1 << UCSZ10));\r
        \r
-       /* Enable double speed, gives better error percentages at 8MHz */\r
-       UCSR1A = (1 << U2X1);\r
-       \r
-       /* Enable transmit and receive modules and interrupts */\r
+       UCSR1A = (1 << U2X1);   \r
        UCSR1B = ((1 << RXCIE1) | (1 << TXEN1) | (1 << RXEN1));\r
-\r
-       /* Set the USART mode to the mask generated by the Line Coding options */\r
-       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
+       UCSR1C = ConfigMask;    \r
+       UBRR1  = SERIAL_2X_UBBRVAL((uint16_t)CDCInterfaceInfo->LineEncoding.BaudRateBPS);\r
 }\r