Remove warnings in the documentation for the library class drivers about sequential...

[pub/USBasp.git] / Demos / Device / Incomplete / TestAndMeasurement / TestAndMeasurement.c

diff --git a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
index d56a7f7..0767127 100644 (file)
--- a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
+++ b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
@@ -1,13 +1,13 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2010.\r
+     Copyright (C) Dean Camera, 2011.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
               \r
   dean [at] fourwalledcubicle [dot] com\r

-      www.fourwalledcubicle.com\r
+           www.lufa-lib.org\r

 */\r
 \r
 /*\r
 */\r
 \r
 /*\r

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r
 \r
   Permission to use, copy, modify, distribute, and sell this \r
   software and its documentation for any purpose is hereby granted\r


@@ -36,14 +36,14 @@
  */\r
 TMC_Capabilities_t Capabilities =\r
        {\r
  */\r
 TMC_Capabilities_t Capabilities =\r
        {\r

-               .Status     = TMC_REQUEST_STATUS_SUCCESS,\r
+               .Status     = TMC_STATUS_SUCCESS,\r

                .TMCVersion = VERSION_BCD(1.00),\r
                \r
                .Interface  =\r
                        {\r
                                .ListenOnly             = false,\r
                                .TalkOnly               = false,\r
                .TMCVersion = VERSION_BCD(1.00),\r
                \r
                .Interface  =\r
                        {\r
                                .ListenOnly             = false,\r
                                .TalkOnly               = false,\r

-                               .PulseIndicateSupported = true,\r
+                               .PulseIndicateSupported = false,\r

                        },\r
 \r
                .Device     =\r
                        },\r
 \r
                .Device     =\r


@@ -52,6 +52,20 @@ TMC_Capabilities_t Capabilities =
                        },\r
        };\r
 \r
                        },\r
        };\r
 \r

+/** Current TMC control request that is being processed */\r
+static uint8_t RequestInProgress = 0;\r
+\r
+/** Stream callback abort flag for bulk IN data */\r
+static bool IsTMCBulkINReset = false;\r
+\r
+/** Stream callback abort flag for bulk OUT data */\r
+static bool IsTMCBulkOUTReset = false;\r
+\r
+/** Last used tag value for data transfers */\r
+static uint8_t CurrentTransferTag = 0;\r
+\r
+/** Length of last data transfer, for reporting to the host in case an in-progress transfer is aborted */\r
+static uint32_t LastTransferLength = 0;\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
 /** Main program entry point. This routine contains the overall program flow, including initial\r
  *  setup of all components and the main program loop.\r


@@ -85,111 +99,339 @@ void SetupHardware(void)
        USB_Init();\r
 }\r
 \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_Device_Connect(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
 }\r
 \r
 void EVENT_USB_Device_Connect(void)\r
 {\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_Device_Disconnect(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
 }\r
 \r
 void EVENT_USB_Device_Disconnect(void)\r
 {\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_Device_ConfigurationChanged(void)\r
 {\r
 void EVENT_USB_Device_ConfigurationChanged(void)\r
 {\r

-       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+       bool ConfigSuccess = true;\r

 \r
 \r

-       /* Setup TMC In and Out Endpoints */\r
-       if (!(Endpoint_ConfigureEndpoint(TMC_IN_EPNUM, EP_TYPE_BULK,\r
-                                            ENDPOINT_DIR_IN, TMC_IO_EPSIZE,\r
-                                        ENDPOINT_BANK_SINGLE)))\r
-       {\r
-               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       }\r
+       /* Setup TMC In, Out and Notification Endpoints */\r
+       ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_NOTIFICATION_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,\r
+                                                   TMC_IO_EPSIZE, ENDPOINT_BANK_SINGLE);\r
+       ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_IN_EPNUM,  EP_TYPE_BULK, ENDPOINT_DIR_IN,\r
+                                                   TMC_IO_EPSIZE, ENDPOINT_BANK_SINGLE);\r
+       ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_OUT_EPNUM, EP_TYPE_BULK, ENDPOINT_DIR_OUT,\r
+                                                   TMC_IO_EPSIZE, ENDPOINT_BANK_SINGLE);\r

 \r
 \r

-       if (!(Endpoint_ConfigureEndpoint(TMC_OUT_EPNUM, EP_TYPE_BULK,\r
-                                            ENDPOINT_DIR_OUT, TMC_IO_EPSIZE,\r
-                                        ENDPOINT_BANK_SINGLE)))\r
-       {\r
-               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       }\r
+       /* Indicate endpoint configuration success or failure */\r
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);\r

 }\r
 \r
 }\r
 \r

-void EVENT_USB_Device_UnhandledControlRequest(void)\r
+/** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to\r
+ *  the device from the USB host before passing along unhandled control requests to the library for processing\r
+ *  internally.\r
+ */\r
+void EVENT_USB_Device_ControlRequest(void)\r

 {\r
 {\r

+       uint8_t TMCRequestStatus = TMC_STATUS_SUCCESS;\r
+\r
+       /* Process TMC specific control requests */\r

        switch (USB_ControlRequest.bRequest)\r
        {\r
                case Req_InitiateAbortBulkOut:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r
        switch (USB_ControlRequest.bRequest)\r
        {\r
                case Req_InitiateAbortBulkOut:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r

-                       \r
+                               /* Check that no split transaction is already in progress and the data transfer tag is valid */\r
+                               if (RequestInProgress != 0)\r
+                               {\r
+                                       TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;\r
+                               }\r
+                               else if (USB_ControlRequest.wValue != CurrentTransferTag)\r
+                               {\r
+                                       TMCRequestStatus = TMC_STATUS_TRANSFER_NOT_IN_PROGRESS;\r
+                               }\r
+                               else\r
+                               {\r
+                                       /* Indicate that all in-progress/pending data OUT requests should be aborted */\r
+                                       IsTMCBulkOUTReset = true;\r
+                                       \r
+                                       /* Save the split request for later checking when a new request is received */\r
+                                       RequestInProgress = Req_InitiateAbortBulkOut;\r
+                               }\r
+\r
+                               Endpoint_ClearSETUP();\r
+                               \r
+                               /* Write the request response byte */\r
+                               Endpoint_Write_8(TMCRequestStatus);\r
+\r
+                               Endpoint_ClearIN();\r
+                               Endpoint_ClearStatusStage();\r

                        }\r
                        \r
                        break;\r
                case Req_CheckAbortBulkOutStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r
                        }\r
                        \r
                        break;\r
                case Req_CheckAbortBulkOutStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r

-                       \r
+                               /* Check that an ABORT BULK OUT transaction has been requested and that the request has completed */\r
+                               if (RequestInProgress != Req_InitiateAbortBulkOut)\r
+                                 TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;                          \r
+                               else if (IsTMCBulkOUTReset)\r
+                                 TMCRequestStatus = TMC_STATUS_PENDING;\r
+                               else\r
+                                 RequestInProgress = 0;        \r
+\r
+                               Endpoint_ClearSETUP();\r
+                                                               \r
+                               /* Write the request response bytes */\r
+                               Endpoint_Write_8(TMCRequestStatus);\r
+                               Endpoint_Write_16_LE(0);\r
+                               Endpoint_Write_32_LE(LastTransferLength);\r
+\r
+                               Endpoint_ClearIN();\r
+                               Endpoint_ClearStatusStage();                            \r

                        }\r
                        \r
                        break;\r
                case Req_InitiateAbortBulkIn:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r
                        }\r
                        \r
                        break;\r
                case Req_InitiateAbortBulkIn:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r

-                       \r
+                               /* Check that no split transaction is already in progress and the data transfer tag is valid */\r
+                               if (RequestInProgress != 0)\r
+                               {\r
+                                       TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;                                \r
+                               }\r
+                               else if (USB_ControlRequest.wValue != CurrentTransferTag)\r
+                               {\r
+                                       TMCRequestStatus = TMC_STATUS_TRANSFER_NOT_IN_PROGRESS;\r
+                               }\r
+                               else\r
+                               {\r
+                                       /* Indicate that all in-progress/pending data IN requests should be aborted */\r
+                                       IsTMCBulkINReset = true;\r
+                                       \r
+                                       /* Save the split request for later checking when a new request is received */\r
+                                       RequestInProgress = Req_InitiateAbortBulkIn;\r
+                               }\r
+\r
+                               Endpoint_ClearSETUP();\r
+                               \r
+                               /* Write the request response bytes */\r
+                               Endpoint_Write_8(TMCRequestStatus);\r
+                               Endpoint_Write_8(CurrentTransferTag);\r
+\r
+                               Endpoint_ClearIN();\r
+                               Endpoint_ClearStatusStage();\r

                        }\r
                        \r
                        break;\r
                case Req_CheckAbortBulkInStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r
                        }\r
                        \r
                        break;\r
                case Req_CheckAbortBulkInStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r

-                       \r
+                               /* Check that an ABORT BULK IN transaction has been requested and that the request has completed */\r
+                               if (RequestInProgress != Req_InitiateAbortBulkIn)\r
+                                 TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;\r
+                               else if (IsTMCBulkINReset)\r
+                                 TMCRequestStatus = TMC_STATUS_PENDING;\r
+                               else\r
+                                 RequestInProgress = 0;\r
+\r
+                               Endpoint_ClearSETUP();\r
+                                                               \r
+                               /* Write the request response bytes */\r
+                               Endpoint_Write_8(TMCRequestStatus);\r
+                               Endpoint_Write_16_LE(0);\r
+                               Endpoint_Write_32_LE(LastTransferLength);\r
+\r
+                               Endpoint_ClearIN();\r
+                               Endpoint_ClearStatusStage();\r

                        }\r
                        \r
                        break;\r
                case Req_InitiateClear:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
                        }\r
                        \r
                        break;\r
                case Req_InitiateClear:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r

-                       \r
+                               /* Check that no split transaction is already in progress */\r
+                               if (RequestInProgress != 0)\r
+                               {\r
+                                       Endpoint_Write_8(TMC_STATUS_SPLIT_IN_PROGRESS);                         \r
+                               }\r
+                               else\r
+                               {\r
+                                       /* Indicate that all in-progress/pending data IN and OUT requests should be aborted */\r
+                                       IsTMCBulkINReset  = true;\r
+                                       IsTMCBulkOUTReset = true;\r
+                                       \r
+                                       /* Save the split request for later checking when a new request is received */\r
+                                       RequestInProgress = Req_InitiateClear;\r
+                               }\r
+\r
+                               Endpoint_ClearSETUP();\r
+                               \r
+                               /* Write the request response byte */\r
+                               Endpoint_Write_8(TMCRequestStatus);\r
+\r
+                               Endpoint_ClearIN();\r
+                               Endpoint_ClearStatusStage();\r

                        }\r
                        \r
                        break;\r
                case Req_CheckClearStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
                        }\r
                        \r
                        break;\r
                case Req_CheckClearStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r

-                       \r
+                               /* Check that a CLEAR transaction has been requested and that the request has completed */\r
+                               if (RequestInProgress != Req_InitiateClear)\r
+                                 TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;                          \r
+                               else if (IsTMCBulkINReset || IsTMCBulkOUTReset)\r
+                                 TMCRequestStatus = TMC_STATUS_PENDING;\r
+                               else\r
+                                 RequestInProgress = 0;\r
+\r
+                               Endpoint_ClearSETUP();\r
+\r
+                               /* Write the request response bytes */\r
+                               Endpoint_Write_8(TMCRequestStatus);\r
+                               Endpoint_Write_8(0);\r
+                               \r
+                               Endpoint_ClearIN();\r
+                               Endpoint_ClearStatusStage();                            \r

                        }\r
                        \r
                        break;\r
                case Req_GetCapabilities:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
                        }\r
                        \r
                        break;\r
                case Req_GetCapabilities:\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 device capabilities to the control endpoint */\r
                                Endpoint_ClearSETUP();\r
                                        \r
                                /* Write the device capabilities to the control endpoint */\r

-                               Endpoint_Write_Control_Stream_LE(&Capabilities, sizeof(TMC_Capabilities_t));\r
-                               \r
-                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
+                               Endpoint_Write_Control_Stream_LE(&Capabilities, sizeof(TMC_Capabilities_t));                            \r

                                Endpoint_ClearOUT();\r
                        }\r
                        \r
                        break;\r
        }\r
 }\r
                                Endpoint_ClearOUT();\r
                        }\r
                        \r
                        break;\r
        }\r
 }\r

-       \r
+\r
+/** Function to manage TMC data transmission and reception to and from the host. */\r

 void TMC_Task(void)\r
 {\r
        /* Device must be connected and configured for the task to run */\r
        if (USB_DeviceState != DEVICE_STATE_Configured)\r
          return;\r
 void TMC_Task(void)\r
 {\r
        /* Device must be connected and configured for the task to run */\r
        if (USB_DeviceState != DEVICE_STATE_Configured)\r
          return;\r

-         \r
+       \r
+       TMC_MessageHeader_t MessageHeader;\r
+       uint16_t            BytesTransferred;\r
+       \r
+       /* Try to read in a TMC message from the interface, process if one is available */\r
+       if (ReadTMCHeader(&MessageHeader))\r
+       {\r
+               /* Indicate busy */\r
+               LEDs_SetAllLEDs(LEDMASK_USB_BUSY);\r
+               \r
+               switch (MessageHeader.MessageID)\r
+               {\r
+                       case TMC_MESSAGEID_DEV_DEP_MSG_OUT:\r
+                               BytesTransferred = 0;\r
+                               while (Endpoint_Discard_Stream(MessageHeader.TransferSize, &BytesTransferred) ==\r
+                                      ENDPOINT_RWSTREAM_IncompleteTransfer)\r
+                               {\r
+                                       if (IsTMCBulkOUTReset)\r
+                                         break;\r
+                               }\r
+                               LastTransferLength = BytesTransferred;\r
+                               \r
+                               Endpoint_ClearOUT();\r
+                               break;\r
+                       case TMC_MESSAGEID_DEV_DEP_MSG_IN:\r
+                               Endpoint_ClearOUT();\r
+\r
+                               MessageHeader.TransferSize = 3;\r
+                               MessageHeader.MessageIDSpecific.DeviceOUT.LastMessageTransaction = true;\r
+                               WriteTMCHeader(&MessageHeader);\r
+\r
+                               BytesTransferred = 0;\r
+                               while (Endpoint_Write_Stream_LE("TMC", MessageHeader.TransferSize, &BytesTransferred) ==\r
+                                      ENDPOINT_RWSTREAM_IncompleteTransfer)\r
+                               {\r
+                                       if (IsTMCBulkINReset)\r
+                                         break;\r
+                               }\r
+                               LastTransferLength = BytesTransferred;\r
+\r
+                               Endpoint_ClearIN();\r
+                               break;\r
+                       default:\r
+                               Endpoint_StallTransaction();\r
+                               break;\r
+               }\r
+\r
+               LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
+       }\r
+       \r
+       /* All pending data has been processed - reset the data abort flags */\r
+       IsTMCBulkINReset  = false;\r
+       IsTMCBulkOUTReset = false;\r
+}\r
+\r
+/** Attempts to read in the TMC message header from the TMC interface.\r
+ *\r
+ *  \param[out] MessageHeader  Pointer to a location where the read header (if any) should be stored\r
+ *\r
+ *  \return Boolean true if a header was read, false otherwise\r
+ */\r
+bool ReadTMCHeader(TMC_MessageHeader_t* const MessageHeader)\r
+{\r
+       uint16_t BytesTransferred;\r
+\r
+       /* Select the Data Out endpoint */\r

        Endpoint_SelectEndpoint(TMC_OUT_EPNUM);\r
        \r
        Endpoint_SelectEndpoint(TMC_OUT_EPNUM);\r
        \r

-       if (Endpoint_IsOUTReceived())\r
+       /* Abort if no command has been sent from the host */\r
+       if (!(Endpoint_IsOUTReceived()))\r
+         return false;\r
+       \r
+       /* Read in the header of the command from the host */\r
+       BytesTransferred = 0;\r
+       while (Endpoint_Read_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), &BytesTransferred) ==\r
+              ENDPOINT_RWSTREAM_IncompleteTransfer)\r

        {\r
        {\r

-               // TEMP - Indicate data received\r
-               LEDs_SetAllLEDs(LEDS_ALL_LEDS);\r
-               Endpoint_ClearOUT();\r
+               if (IsTMCBulkOUTReset)\r
+                 break;\r

        }\r
        }\r

+\r
+       /* Store the new command tag value for later use */\r
+       CurrentTransferTag = MessageHeader->Tag;\r
+       \r
+       /* Indicate if the command has been aborted or not */\r
+       return !(IsTMCBulkOUTReset);\r
+}\r
+\r
+bool WriteTMCHeader(TMC_MessageHeader_t* const MessageHeader)\r
+{\r
+       uint16_t BytesTransferred;\r
+\r
+       /* Set the message tag of the command header */\r
+       MessageHeader->Tag        =  CurrentTransferTag;\r
+       MessageHeader->InverseTag = ~CurrentTransferTag;\r
+\r
+       /* Select the Data In endpoint */\r
+       Endpoint_SelectEndpoint(TMC_IN_EPNUM);\r
+\r
+       /* Send the command header to the host */\r
+       BytesTransferred = 0;\r
+       while (Endpoint_Write_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), &BytesTransferred) ==\r
+              ENDPOINT_RWSTREAM_IncompleteTransfer)\r
+       {\r
+               if (IsTMCBulkINReset)\r
+                 break;\r
+       }\r
+\r
+       /* Indicate if the command has been aborted or not */\r
+       return !(IsTMCBulkINReset);\r

 }\r
 }\r