Invert the logic for the VBUS power light in the AVRISP-MKII project for the USBTINY...
[pub/USBasp.git] / Demos / Device / Incomplete / TestAndMeasurement / TestAndMeasurement.c
index 184e2e2..cab978a 100644 (file)
@@ -36,7 +36,7 @@
  */\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
@@ -53,19 +53,16 @@ TMC_Capabilities_t Capabilities =
        };\r
 \r
 /** Current TMC control request that is being processed */\r
-uint8_t RequestInProgess = 0;\r
+uint8_t RequestInProgress = 0;\r
 \r
 /** Stream callback abort flag for bulk IN data */\r
-bool IsTMCBulkINReset    = false;\r
+bool IsTMCBulkINReset = false;\r
 \r
 /** Stream callback abort flag for bulk OUT data */\r
-bool IsTMCBulkOUTReset   = false;\r
+bool IsTMCBulkOUTReset = false;\r
 \r
-/** Last used tag value for bulk IN transfers */\r
-uint8_t NextTransferINTag  = 0;\r
-\r
-/** Last used tag value for bulk IN transfers */\r
-uint8_t NextTransferOUTTag  = 0;\r
+/** Last used tag value for data transfers */\r
+uint8_t CurrentTransferTag = 0;\r
 \r
 \r
 /** Main program entry point. This routine contains the overall program flow, including initial\r
@@ -100,16 +97,25 @@ void SetupHardware(void)
        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
+/** 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
+/** 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
        LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
@@ -130,10 +136,15 @@ void EVENT_USB_Device_ConfigurationChanged(void)
        }\r
 }\r
 \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_Device_UnhandledControlRequest(void)\r
 {\r
-       uint8_t TMCRequestStatus = TMC_REQUEST_STATUS_SUCCESS;\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
@@ -141,13 +152,14 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                        {\r
                                Endpoint_ClearSETUP();\r
                                \r
-                               if (RequestInProgess != 0)\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_REQUEST_STATUS_SPLIT_IN_PROGRESS;\r
+                                       TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;\r
                                }\r
-                               else if (USB_ControlRequest.wValue != NextTransferOUTTag)\r
+                               else if (USB_ControlRequest.wValue != CurrentTransferTag)\r
                                {\r
-                                       TMCRequestStatus = TMC_REQUEST_STATUS_TRANSFER_NOT_IN_PROGRESS;\r
+                                       TMCRequestStatus = TMC_STATUS_TRANSFER_NOT_IN_PROGRESS;\r
                                }\r
                                else\r
                                {\r
@@ -155,7 +167,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                        IsTMCBulkOUTReset = true;\r
                                        \r
                                        /* Save the split request for later checking when a new request is received */\r
-                                       RequestInProgess = Req_InitiateAbortBulkOut;\r
+                                       RequestInProgress = Req_InitiateAbortBulkOut;\r
                                }\r
                                \r
                                /* Write the request response byte */\r
@@ -171,12 +183,13 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                        {\r
                                Endpoint_ClearSETUP();\r
                                \r
-                               if (RequestInProgess != Req_InitiateAbortBulkOut)\r
-                                 TMCRequestStatus = TMC_REQUEST_STATUS_SPLIT_NOT_IN_PROGRESS;                          \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_REQUEST_STATUS_PENDING;\r
+                                 TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r
-                                 RequestInProgess = 0;                 \r
+                                 RequestInProgress = 0;                        \r
                                \r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
@@ -193,26 +206,27 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                        {\r
                                Endpoint_ClearSETUP();\r
                                \r
-                               if (RequestInProgess != 0)\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_REQUEST_STATUS_SPLIT_IN_PROGRESS;                                \r
+                                       TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;                                \r
                                }\r
-                               else if (USB_ControlRequest.wValue != NextTransferINTag)\r
+                               else if (USB_ControlRequest.wValue != CurrentTransferTag)\r
                                {\r
-                                       TMCRequestStatus = TMC_REQUEST_STATUS_TRANSFER_NOT_IN_PROGRESS;\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
+                                       IsTMCBulkINReset = true;\r
                                        \r
                                        /* Save the split request for later checking when a new request is received */\r
-                                       RequestInProgess = Req_InitiateAbortBulkIn;\r
+                                       RequestInProgress = Req_InitiateAbortBulkIn;\r
                                }\r
                                \r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
-                               Endpoint_Write_Byte(NextTransferINTag);\r
+                               Endpoint_Write_Byte(CurrentTransferTag);\r
 \r
                                Endpoint_ClearIN();\r
                                Endpoint_ClearStatusStage();\r
@@ -224,12 +238,13 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                        {\r
                                Endpoint_ClearSETUP();\r
                                \r
-                               if (RequestInProgess != Req_InitiateAbortBulkIn)\r
-                                 TMCRequestStatus = TMC_REQUEST_STATUS_SPLIT_NOT_IN_PROGRESS;\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_REQUEST_STATUS_PENDING;\r
+                                 TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r
-                                 RequestInProgess = 0;\r
+                                 RequestInProgress = 0;\r
                                \r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
@@ -246,9 +261,10 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                        {\r
                                Endpoint_ClearSETUP();\r
                                \r
-                               if (RequestInProgess != 0)\r
+                               /* Check that no split transaction is already in progress */\r
+                               if (RequestInProgress != 0)\r
                                {\r
-                                       Endpoint_Write_Byte(TMC_REQUEST_STATUS_SPLIT_IN_PROGRESS);                              \r
+                                       Endpoint_Write_Byte(TMC_STATUS_SPLIT_IN_PROGRESS);                              \r
                                }\r
                                else\r
                                {\r
@@ -257,7 +273,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                        IsTMCBulkOUTReset = true;\r
                                        \r
                                        /* Save the split request for later checking when a new request is received */\r
-                                       RequestInProgess = Req_InitiateClear;\r
+                                       RequestInProgress = Req_InitiateClear;\r
                                }\r
                                \r
                                /* Write the request response byte */\r
@@ -273,12 +289,13 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                        {\r
                                Endpoint_ClearSETUP();\r
                                \r
-                               if (RequestInProgess != Req_InitiateClear)\r
-                                 TMCRequestStatus = TMC_REQUEST_STATUS_SPLIT_NOT_IN_PROGRESS;                          \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_REQUEST_STATUS_PENDING;\r
+                                 TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r
-                                 RequestInProgess = 0;\r
+                                 RequestInProgress = 0;\r
                                \r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
@@ -305,20 +322,43 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                        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
-         \r
-       Endpoint_SelectEndpoint(TMC_OUT_EPNUM);\r
        \r
-       if (Endpoint_IsOUTReceived())\r
+       TMC_MessageHeader_t MessageHeader;\r
+       \r
+       /* Check if a TMC packet has been received */\r
+       if (ReadTMCHeader(&MessageHeader))\r
        {\r
-               // TEMP - Indicate data received\r
-               LEDs_SetAllLEDs(LEDS_ALL_LEDS);\r
-               Endpoint_ClearOUT();\r
+               /* Indicate busy */\r
+               LEDs_SetAllLEDs(LEDMASK_USB_BUSY);\r
+               \r
+               switch (MessageHeader.MessageID)\r
+               {\r
+                       case TMC_MESSAGEID_DEV_DEP_MSG_OUT:\r
+                               Endpoint_Discard_Stream(MessageHeader.TransferSize, StreamCallback_AbortOUTOnRequest);\r
+                               Endpoint_ClearOUT();\r
+                               break;\r
+                       case TMC_MESSAGEID_DEV_DEP_MSG_IN:\r
+                               Endpoint_ClearOUT();\r
+\r
+                               MessageHeader.TransferSize = 3;\r
+                               WriteTMCHeader(&MessageHeader);\r
+\r
+                               Endpoint_Write_Stream_LE("TMC", 3, StreamCallback_AbortINOnRequest);\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
@@ -326,6 +366,45 @@ void TMC_Task(void)
        IsTMCBulkOUTReset = false;\r
 }\r
 \r
+bool ReadTMCHeader(TMC_MessageHeader_t* const MessageHeader)\r
+{\r
+       /* Select the Data Out endpoint */\r
+       Endpoint_SelectEndpoint(TMC_OUT_EPNUM);\r
+       \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
+       Endpoint_Read_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), StreamCallback_AbortOUTOnRequest);\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
+       /* Compute the next transfer tag value, must be between 1 and 254 */\r
+       if (++CurrentTransferTag == 0xFF)\r
+         CurrentTransferTag = 1;\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
+       Endpoint_Write_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), StreamCallback_AbortINOnRequest);\r
+\r
+       /* Indicate if the command has been aborted or not */\r
+       return !IsTMCBulkINReset;\r
+}\r
+\r
 /** Stream callback function for the Endpoint stream write functions. This callback will abort the current stream transfer\r
  *  if a TMC Abort Bulk IN request has been issued to the control endpoint.\r
  */\r