Added Doxygen documentation to the Audio class driver. Added new modules for each...

[pub/USBasp.git] / Demos / Device / DualCDC / DualCDC.c

diff --git a/Demos/Device/DualCDC/DualCDC.c b/Demos/Device/DualCDC/DualCDC.c
index fecbaff..216902c 100644 (file)
--- a/Demos/Device/DualCDC/DualCDC.c
+++ b/Demos/Device/DualCDC/DualCDC.c
@@ -30,73 +30,82 @@
 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r

- *  Main source file for the DualCDC demo. This file contains the main tasks of the demo and\r
- *  is responsible for the initial application hardware configuration.\r
+ *  Main source file for the DualCDC demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r

  */\r
  */\r

- \r
+\r

 #include "DualCDC.h"\r
 \r
 #include "DualCDC.h"\r
 \r

-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName,    "LUFA DualCDC App");\r
-BUTTLOADTAG(BuildTime,   __TIME__);\r
-BUTTLOADTAG(BuildDate,   __DATE__);\r
-BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
+/** LUFA CDC Class driver interface configuration and state information. This structure is\r
+ *  passed to all CDC Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another. This is for the first CDC interface,\r
+ *  which sends strings to the host for each joystick movement.\r
+ */\r
+USB_ClassInfo_CDC_t VirtualSerial1_CDC_Interface =\r
+       {\r
+               .ControlInterfaceNumber     = 0,\r

 \r
 \r

-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r
-       { Task: CDC1_Task            , TaskStatus: TASK_STOP },\r
-       { Task: CDC2_Task            , TaskStatus: TASK_STOP },\r
-};\r
+               .DataINEndpointNumber       = CDC1_TX_EPNUM,\r
+               .DataINEndpointSize         = CDC_TXRX_EPSIZE,\r

 \r
 \r

-/* Globals: */\r
-/** Contains the current baud rate and other settings of the first virtual serial port. While this demo does not use\r
- *  the physical USART and thus does not use these settings, they must still be retained and returned to the host\r
- *  upon request or the host will assume the device is non-functional.\r
- *\r
- *  These values are set by the host via a class-specific request, however they are not required to be used accurately.\r
- *  It is possible to completely ignore these value or use other settings as the host is completely unaware of the physical\r
- *  serial link characteristics and instead sends and receives data in endpoint streams.\r
- */\r
-CDC_Line_Coding_t LineCoding1 = { BaudRateBPS: 9600,\r
-                                  CharFormat:  OneStopBit,\r
-                                  ParityType:  Parity_None,\r
-                                  DataBits:    8            };\r
+               .DataOUTEndpointNumber      = CDC1_RX_EPNUM,\r
+               .DataOUTEndpointSize        = CDC_TXRX_EPSIZE,\r

 \r
 \r

-/** Contains the current baud rate and other settings of the second virtual serial port. While this demo does not use\r
- *  the physical USART and thus does not use these settings, they must still be retained and returned to the host\r
- *  upon request or the host will assume the device is non-functional.\r
- *\r
- *  These values are set by the host via a class-specific request, however they are not required to be used accurately.\r
- *  It is possible to completely ignore these value or use other settings as the host is completely unaware of the physical\r
- *  serial link characteristics and instead sends and receives data in endpoint streams.\r
- */\r
-CDC_Line_Coding_t LineCoding2 = { BaudRateBPS: 9600,\r
-                                  CharFormat:  OneStopBit,\r
-                                  ParityType:  Parity_None,\r
-                                  DataBits:    8            };\r
-                                                                 \r
-/** String to print through the first virtual serial port when the joystick is pressed upwards. */\r
-char JoystickUpString[]      = "Joystick Up\r\n";\r
+               .NotificationEndpointNumber = CDC1_NOTIFICATION_EPNUM,\r
+               .NotificationEndpointSize   = CDC_NOTIFICATION_EPSIZE,\r
+       };\r

 \r
 \r

-/** String to print through the first virtual serial port when the joystick is pressed downward. */\r
-char JoystickDownString[]    = "Joystick Down\r\n";\r
+/** LUFA CDC Class driver interface configuration and state information. This structure is\r
+ *  passed to all CDC Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another. This is for the second CDC interface,\r
+ *  which echos back all received data from the host.\r
+ */\r
+USB_ClassInfo_CDC_t VirtualSerial2_CDC_Interface =\r
+       {\r
+               .ControlInterfaceNumber     = 2,\r

 \r
 \r

-/** String to print through the first virtual serial port when the joystick is pressed left. */\r
-char JoystickLeftString[]    = "Joystick Left\r\n";\r
+               .DataINEndpointNumber       = CDC2_TX_EPNUM,\r
+               .DataINEndpointSize         = CDC_TXRX_EPSIZE,\r

 \r
 \r

-/** String to print through the first virtual serial port when the joystick is pressed right. */\r
-char JoystickRightString[]   = "Joystick Right\r\n";\r
+               .DataOUTEndpointNumber      = CDC2_RX_EPNUM,\r
+               .DataOUTEndpointSize        = CDC_TXRX_EPSIZE,\r

 \r
 \r

-/** String to print through the first virtual serial port when the joystick is pressed inwards. */\r
-char JoystickPressedString[] = "Joystick Pressed\r\n";\r
+               .NotificationEndpointNumber = CDC2_NOTIFICATION_EPNUM,\r
+               .NotificationEndpointSize   = CDC_NOTIFICATION_EPSIZE,\r
+       };\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
+/** Main program entry point. This routine contains the overall program flow, including initial\r
+ *  setup of all components and the main program loop.\r

  */\r
 int main(void)\r
 {\r
  */\r
 int main(void)\r
 {\r

+       SetupHardware();\r
+       \r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               CheckJoystickMovement();\r
+\r
+               /* Discard all received data on the first CDC interface */\r
+               uint16_t BytesToDiscard = USB_CDC_BytesReceived(&VirtualSerial1_CDC_Interface);\r
+               while (BytesToDiscard--)\r
+                 USB_CDC_ReceiveByte(&VirtualSerial1_CDC_Interface);\r
+\r
+               /* Echo all received data on the second CDC interface */\r
+               uint16_t BytesToEcho = USB_CDC_BytesReceived(&VirtualSerial2_CDC_Interface);\r
+               while (BytesToEcho--)\r
+                 USB_CDC_SendByte(&VirtualSerial2_CDC_Interface, USB_CDC_ReceiveByte(&VirtualSerial2_CDC_Interface));\r
+                 \r
+               USB_CDC_USBTask(&VirtualSerial1_CDC_Interface);\r
+               USB_CDC_USBTask(&VirtualSerial2_CDC_Interface);\r
+               USB_USBTask();\r
+       }\r
+}\r
+\r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
+void SetupHardware(void)\r
+{\r

        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r


@@ -107,253 +116,75 @@ int main(void)
        /* Hardware Initialization */\r
        Joystick_Init();\r
        LEDs_Init();\r
        /* Hardware Initialization */\r
        Joystick_Init();\r
        LEDs_Init();\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
        USB_Init();\r

-\r
-       /* Scheduling - routine never returns, so put this last in the main function */\r
-       Scheduler_Start();\r

 }\r
 \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
+/** Checks for changes in the position of the board joystick, sending strings to the host upon each change\r
+ *  through the first of the CDC interfaces.\r

  */\r
  */\r

-EVENT_HANDLER(USB_Connect)\r
+void CheckJoystickMovement(void)\r

 {\r
 {\r

-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-\r
-       /* Indicate USB enumerating */\r
-       UpdateStatus(Status_USBEnumerating);\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
-EVENT_HANDLER(USB_Disconnect)\r
-{\r
-       /* Stop running CDC and USB management tasks */\r
-       Scheduler_SetTaskMode(CDC1_Task, TASK_STOP);\r
-       Scheduler_SetTaskMode(CDC2_Task, TASK_STOP);\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-\r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\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 tasks are started.\r
- */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
-{\r
-       /* Setup CDC Notification, Rx and Tx Endpoints for the first CDC */\r
-       Endpoint_ConfigureEndpoint(CDC1_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       Endpoint_ConfigureEndpoint(CDC1_TX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       Endpoint_ConfigureEndpoint(CDC1_RX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_OUT, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Setup CDC Notification, Rx and Tx Endpoints for the second CDC */\r
-       Endpoint_ConfigureEndpoint(CDC2_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, CDC_NOTIFICATION_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       Endpoint_ConfigureEndpoint(CDC2_TX_EPNUM, EP_TYPE_BULK,\r
-                                      ENDPOINT_DIR_IN, CDC_TXRX_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       Endpoint_ConfigureEndpoint(CDC2_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 tasks */\r
-       Scheduler_SetTaskMode(CDC1_Task, TASK_RUN);\r
-       Scheduler_SetTaskMode(CDC2_Task, TASK_RUN);\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
-EVENT_HANDLER(USB_UnhandledControlPacket)\r
-{\r
-       uint8_t* LineCodingData;\r
-\r
-       /* Discard the unused wValue parameter */\r
-       Endpoint_Ignore_Word();\r
-\r
-       /* wIndex indicates the interface being controlled */\r
-       uint16_t wIndex = Endpoint_Read_Word_LE();\r
+       uint8_t     JoyStatus_LCL = Joystick_GetStatus();\r
+       char*       ReportString  = NULL;\r
+       static bool ActionSent = false;\r
+\r
+       char* JoystickStrings[] =\r
+               {\r
+                       "Joystick Up\r\n",\r
+                       "Joystick Down\r\n",\r
+                       "Joystick Left\r\n",\r
+                       "Joystick Right\r\n",\r
+                       "Joystick Pressed\r\n",\r
+               };\r

 \r
 \r

-       /* Determine which interface's Line Coding data is being set from the wIndex parameter */\r
-       LineCodingData = (wIndex == 0) ? (uint8_t*)&LineCoding1 : (uint8_t*)&LineCoding2;\r
-\r
-       /* Process CDC specific control requests */\r
-       switch (bRequest)\r
-       {\r
-               case REQ_GetLineEncoding:\r
-                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {       \r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSetupReceived();\r
-\r
-                               /* Write the line coding data to the control endpoint */\r
-                               Endpoint_Write_Control_Stream_LE(LineCodingData, sizeof(CDC_Line_Coding_t));\r
-                               \r
-                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
-                               Endpoint_ClearSetupOUT();\r
-                       }\r
-                       \r
-                       break;\r
-               case REQ_SetLineEncoding:\r
-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSetupReceived();\r
-\r
-                               /* Read the line coding data in from the host into the global struct */\r
-                               Endpoint_Read_Control_Stream_LE(LineCodingData, sizeof(CDC_Line_Coding_t));\r
-\r
-                               /* Finalize the stream transfer to clear the last packet from the host */\r
-                               Endpoint_ClearSetupIN();\r
-                       }\r
-       \r
-                       break;\r
-               case REQ_SetControlLineState:\r
-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               /* Acknowledge the SETUP packet, ready for data transfer */\r
-                               Endpoint_ClearSetupReceived();\r
-                               \r
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsSetupINReady()));\r
-                               Endpoint_ClearSetupIN();\r
-                       }\r
-       \r
-                       break;\r
-       }\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 DualCDC_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
-/** Function to manage CDC data transmission and reception to and from the host for the first CDC interface, which sends joystick\r
- *  movements to the host as ASCII strings.\r
- */\r
-TASK(CDC1_Task)\r
-{\r
-       char*       ReportString    = NULL;\r
-       uint8_t     JoyStatus_LCL   = Joystick_GetStatus();\r
-       static bool ActionSent      = false;\r
-\r
-       /* Determine if a joystick action has occurred */\r

        if (JoyStatus_LCL & JOY_UP)\r
        if (JoyStatus_LCL & JOY_UP)\r

-         ReportString = JoystickUpString;\r
+         ReportString = JoystickStrings[0];\r

        else if (JoyStatus_LCL & JOY_DOWN)\r
        else if (JoyStatus_LCL & JOY_DOWN)\r

-         ReportString = JoystickDownString;\r
+         ReportString = JoystickStrings[1];\r

        else if (JoyStatus_LCL & JOY_LEFT)\r
        else if (JoyStatus_LCL & JOY_LEFT)\r

-         ReportString = JoystickLeftString;\r
+         ReportString = JoystickStrings[2];\r

        else if (JoyStatus_LCL & JOY_RIGHT)\r
        else if (JoyStatus_LCL & JOY_RIGHT)\r

-         ReportString = JoystickRightString;\r
+         ReportString = JoystickStrings[3];\r

        else if (JoyStatus_LCL & JOY_PRESS)\r
        else if (JoyStatus_LCL & JOY_PRESS)\r

-         ReportString = JoystickPressedString;\r
-\r
-       /* Flag management - Only allow one string to be sent per action */\r
-       if (ReportString == NULL)\r
-       {\r
-               ActionSent = false;\r
-       }\r
-       else if (ActionSent == false)\r
+         ReportString = JoystickStrings[4];\r
+       else\r
+         ActionSent = false;\r
+         \r
+       if ((ReportString != NULL) && (ActionSent == false))\r

        {\r
                ActionSent = true;\r
                \r
        {\r
                ActionSent = true;\r
                \r

-               /* Select the Serial Tx Endpoint */\r
-               Endpoint_SelectEndpoint(CDC1_TX_EPNUM);\r
-\r
-               /* Write the String to the Endpoint */\r
-               Endpoint_Write_Stream_LE(ReportString, strlen(ReportString));\r
-               \r
-               /* Finalize the stream transfer to send the last packet */\r
-               Endpoint_ClearCurrentBank();\r
+               USB_CDC_SendString(&VirtualSerial1_CDC_Interface, ReportString, strlen(ReportString));          \r

        }\r
        }\r

+}\r

 \r
 \r

-       /* Select the Serial Rx Endpoint */\r
-       Endpoint_SelectEndpoint(CDC1_RX_EPNUM);\r
-       \r
-       /* Throw away any received data from the host */\r
-       if (Endpoint_ReadWriteAllowed())\r
-         Endpoint_ClearCurrentBank();\r
+/** Event handler for the library USB Connection event. */\r
+void EVENT_USB_Connect(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r

 }\r
 \r
 }\r
 \r

-/** Function to manage CDC data transmission and reception to and from the host for the second CDC interface, which echoes back\r
- *  all data sent to it from the host.\r
- */\r
-TASK(CDC2_Task)\r
+/** Event handler for the library USB Disconnection event. */\r
+void EVENT_USB_Disconnect(void)\r

 {\r
 {\r

-       /* Select the Serial Rx Endpoint */\r
-       Endpoint_SelectEndpoint(CDC2_RX_EPNUM);\r
-       \r
-       /* Check to see if any data has been received */\r
-       if (Endpoint_ReadWriteAllowed())\r
-       {\r
-               /* Create a temp buffer big enough to hold the incoming endpoint packet */\r
-               uint8_t  Buffer[Endpoint_BytesInEndpoint()];\r
-               \r
-               /* Remember how large the incoming packet is */\r
-               uint16_t DataLength = Endpoint_BytesInEndpoint();\r
-       \r
-               /* Read in the incoming packet into the buffer */\r
-               Endpoint_Read_Stream_LE(&Buffer, DataLength);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+}\r
+\r
+/** Event handler for the library USB Configuration Changed event. */\r
+void EVENT_USB_ConfigurationChanged(void)\r
+{\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r

 \r
 \r

-               /* Finalize the stream transfer to send the last packet */\r
-               Endpoint_ClearCurrentBank();\r
+       if (!(USB_CDC_ConfigureEndpoints(&VirtualSerial1_CDC_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r

 \r
 \r

-               /* Select the Serial Tx Endpoint */\r
-               Endpoint_SelectEndpoint(CDC2_TX_EPNUM);\r
-               \r
-               /* Write the received data to the endpoint */\r
-               Endpoint_Write_Stream_LE(&Buffer, DataLength);\r
+       if (!(USB_CDC_ConfigureEndpoints(&VirtualSerial2_CDC_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+}\r

 \r
 \r

-               /* Finalize the stream transfer to send the last packet */\r
-               Endpoint_ClearCurrentBank();\r
-       }\r
+/** Event handler for the library USB Unhandled Control Packet event. */\r
+void EVENT_USB_UnhandledControlPacket(void)\r
+{\r
+       USB_CDC_ProcessControlPacket(&VirtualSerial1_CDC_Interface);\r
+       USB_CDC_ProcessControlPacket(&VirtualSerial2_CDC_Interface);\r

 }\r
 }\r