Added return values to the CDC and MIDI class driver transmit functions.

[pub/USBasp.git] / Demos / Device / LowLevel / CDC / CDC.c

diff --git a/Demos/Device/LowLevel/CDC/CDC.c b/Demos/Device/LowLevel/CDC/CDC.c
index d7ebb9e..0c98c11 100644 (file)
--- a/Demos/Device/LowLevel/CDC/CDC.c
+++ b/Demos/Device/LowLevel/CDC/CDC.c
@@ -36,13 +36,6 @@
 \r
 #include "CDC.h"\r
 \r
 \r
 #include "CDC.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
-\r

 /* Globals: */\r
 /** Contains the current baud rate and other settings of the 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
 /* Globals: */\r
 /** Contains the current baud rate and other settings of the 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


@@ -52,31 +45,82 @@ TASK_LIST
  *  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
  *  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 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
 \r

-/** String to print through the virtual serial port when the joystick is pressed upwards. */\r
-char JoystickUpString[]      = "Joystick Up\r\n";\r
+#if 0\r
+/* NOTE: Here you can set up a standard stream using the created virtual serial port, so that the standard stream functions in\r
+ *       <stdio.h> can be used on the virtual serial port (e.g. fprintf(&USBSerial, "Test"); to print a string).\r
+ */\r
+       \r
+static int CDC_putchar(char c, FILE *stream)\r
+{        \r
+       Endpoint_SelectEndpoint(CDC_TX_EPNUM);\r

 \r
 \r

-/** String to print through the virtual serial port when the joystick is pressed downward. */\r
-char JoystickDownString[]    = "Joystick Down\r\n";\r
+       if (!(LineEncoding.BaudRateBPS))\r
+         return -1;\r
+       \r
+       if (Endpoint_WaitUntilReady())\r
+         return -1;\r

 \r
 \r

-/** String to print through the virtual serial port when the joystick is pressed left. */\r
-char JoystickLeftString[]    = "Joystick Left\r\n";\r
+       Endpoint_Write_Byte(c);\r
+       Endpoint_ClearIN();\r
+       \r
+       return 0;\r
+}\r

 \r
 \r

-/** String to print through the virtual serial port when the joystick is pressed right. */\r
-char JoystickRightString[]   = "Joystick Right\r\n";\r
+static int CDC_getchar(FILE *stream)\r
+{\r
+       int c;\r

 \r
 \r

-/** String to print through the virtual serial port when the joystick is pressed inwards. */\r
-char JoystickPressedString[] = "Joystick Pressed\r\n";\r
+       if (!(LineEncoding.BaudRateBPS))\r
+         return -1;\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
+       Endpoint_SelectEndpoint(CDC_RX_EPNUM);\r
+       \r
+       for (;;)\r
+       {\r
+               if (Endpoint_WaitUntilReady())\r
+                 return -1;\r
+       \r
+               if (!(Endpoint_BytesInEndpoint()))\r
+               {\r
+                       Endpoint_ClearOUT();\r
+               }\r
+               else\r
+               {\r
+                       c = Endpoint_Read_Byte();\r
+                       break;\r
+               }\r
+       }\r
+       \r
+       return c;\r
+}\r
+\r
+static FILE USBSerial = FDEV_SETUP_STREAM(CDC_putchar, CDC_getchar, _FDEV_SETUP_RW);\r
+#endif\r
+\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
+               CDC_Task();\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


@@ -87,78 +131,67 @@ 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
 /** 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
 }\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
 {\r

-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-\r

        /* Indicate USB enumerating */\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
 }\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
+void EVENT_USB_Device_Disconnect(void)\r

 {\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

        /* Indicate USB not ready */\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
 }\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
+void EVENT_USB_Device_ConfigurationChanged(void)\r

 {\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
-\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
        /* Indicate USB connected and ready */\r

-       UpdateStatus(Status_USBReady);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+\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
+       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
        \r

-       /* Start CDC task */\r
-       Scheduler_SetTaskMode(CDC_Task, TASK_RUN);\r
+       /* Reset line encoding baud rate so that the host knows to send new values */\r
+       LineEncoding.BaudRateBPS = 0;\r

 }\r
 \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
  *  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
 {\r

-       uint8_t* LineCodingData = (uint8_t*)&LineCoding;\r
-\r

        /* Process CDC specific control requests */\r
        switch (USB_ControlRequest.bRequest)\r
        {\r
        /* Process CDC specific control requests */\r
        switch (USB_ControlRequest.bRequest)\r
        {\r


@@ -169,7 +202,7 @@ void EVENT_USB_UnhandledControlPacket(void)
                                Endpoint_ClearSETUP();\r
 \r
                                /* Write the line coding data to the control endpoint */\r
                                Endpoint_ClearSETUP();\r
 \r
                                /* Write the line coding data to the control endpoint */\r

-                               Endpoint_Write_Control_Stream_LE(LineCodingData, sizeof(CDC_Line_Coding_t));\r
+                               Endpoint_Write_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));\r

                                \r
                                /* Finalize the stream transfer to send the last packet or clear the host abort */\r
                                Endpoint_ClearOUT();\r
                                \r
                                /* Finalize the stream transfer to send the last packet or clear the host abort */\r
                                Endpoint_ClearOUT();\r


@@ -183,7 +216,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_ClearSETUP();\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
+                               Endpoint_Read_Control_Stream_LE(&LineEncoding, sizeof(CDC_Line_Coding_t));\r

 \r
                                /* Finalize the stream transfer to clear the last packet from the host */\r
                                Endpoint_ClearIN();\r
 \r
                                /* Finalize the stream transfer to clear the last packet from the host */\r
                                Endpoint_ClearIN();\r


@@ -201,53 +234,28 @@ void EVENT_USB_UnhandledControlPacket(void)
                                                 CONTROL_LINE_OUT_* masks to determine the RTS and DTR line states using the following code:\r
                                */\r
                                \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
+                               Endpoint_ClearStatusStage();\r

                        }\r
        \r
                        break;\r
        }\r
 }\r
 \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 CDC_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. */\r
 /** Function to manage CDC data transmission and reception to and from the host. */\r

-TASK(CDC_Task)\r
+void CDC_Task(void)\r

 {\r
        char*       ReportString    = NULL;\r
        uint8_t     JoyStatus_LCL   = Joystick_GetStatus();\r
        static bool ActionSent      = false;\r
        \r
 {\r
        char*       ReportString    = NULL;\r
        uint8_t     JoyStatus_LCL   = Joystick_GetStatus();\r
        static bool ActionSent      = false;\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
 #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
+        *       handshake signal lines (and some error states), via the CONTROL_LINE_IN_* masks and the following code:\r
+        */\r

        USB_Notification_Header_t Notification = (USB_Notification_Header_t)\r
                {\r
                        .NotificationType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r
        USB_Notification_Header_t Notification = (USB_Notification_Header_t)\r
                {\r
                        .NotificationType = (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE),\r


@@ -269,22 +277,20 @@ TASK(CDC_Task)
 \r
        /* Determine if a joystick action has occurred */\r
        if (JoyStatus_LCL & JOY_UP)\r
 \r
        /* Determine if a joystick action has occurred */\r
        if (JoyStatus_LCL & JOY_UP)\r

-         ReportString = JoystickUpString;\r
+         ReportString = "Joystick Up\r\n";\r

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

-         ReportString = JoystickDownString;\r
+         ReportString = "Joystick Down\r\n";\r

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

-         ReportString = JoystickLeftString;\r
+         ReportString = "Joystick Left\r\n";\r

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

-         ReportString = JoystickRightString;\r
+         ReportString = "Joystick Right\r\n";\r

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

-         ReportString = JoystickPressedString;\r
+         ReportString = "Joystick Pressed\r\n";\r
+       else\r
+         ActionSent = false;\r

 \r
        /* Flag management - Only allow one string to be sent per action */\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
+       if ((ReportString != NULL) && (ActionSent == false) && LineEncoding.BaudRateBPS)\r

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


@@ -305,7 +311,7 @@ TASK(CDC_Task)
                if (IsFull)\r
                {\r
                        /* Wait until the endpoint is ready for another packet */\r
                if (IsFull)\r
                {\r
                        /* Wait until the endpoint is ready for another packet */\r

-                       while (!(Endpoint_IsINReady()));\r
+                       Endpoint_WaitUntilReady();\r

                        \r
                        /* Send an empty packet to ensure that the host does not buffer data sent to it */\r
                        Endpoint_ClearIN();\r
                        \r
                        /* Send an empty packet to ensure that the host does not buffer data sent to it */\r
                        Endpoint_ClearIN();\r