Minor documentation improvements.

[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 ab98411..a23521e 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


@@ -53,13 +53,13 @@ TMC_Capabilities_t Capabilities =
        };\r
 \r
 /** Current TMC control request that is being processed */\r
        };\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
 \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
 \r
 /** Stream callback abort flag for bulk OUT data */\r

-bool IsTMCBulkOUTReset     = false;\r
+bool IsTMCBulkOUTReset = false;\r

 \r
 /** Last used tag value for data transfers */\r
 uint8_t CurrentTransferTag = 0;\r
 \r
 /** Last used tag value for data transfers */\r
 uint8_t CurrentTransferTag = 0;\r


@@ -118,29 +118,25 @@ void EVENT_USB_Device_Disconnect(void)
  */\r
 void EVENT_USB_Device_ConfigurationChanged(void)\r
 {\r
  */\r
 void EVENT_USB_Device_ConfigurationChanged(void)\r
 {\r

-       LEDs_SetAllLEDs(LEDMASK_USB_READY);\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
-\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
+       bool ConfigSuccess = true;\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
+       /* Indicate endpoint configuration success or failure */\r
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);\r

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

-void EVENT_USB_Device_UnhandledControlRequest(void)\r
+void EVENT_USB_Device_ControlRequest(void)\r

 {\r
        uint8_t TMCRequestStatus = TMC_STATUS_SUCCESS;\r
 \r
 {\r
        uint8_t TMCRequestStatus = TMC_STATUS_SUCCESS;\r
 \r


@@ -150,10 +146,8 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                case Req_InitiateAbortBulkOut:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r
                case Req_InitiateAbortBulkOut:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r

-                               Endpoint_ClearSETUP();\r
-                               \r

                                /* Check that no split transaction is already in progress and the data transfer tag is valid */\r
                                /* Check that no split transaction is already in progress and the data transfer tag is valid */\r

-                               if (RequestInProgess != 0)\r
+                               if (RequestInProgress != 0)\r

                                {\r
                                        TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;\r
                                }\r
                                {\r
                                        TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;\r
                                }\r


@@ -167,8 +161,10 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                        IsTMCBulkOUTReset = true;\r
                                        \r
                                        /* Save the split request for later checking when a new request is received */\r
                                        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

+\r
+                               Endpoint_ClearSETUP();\r

                                \r
                                /* Write the request response byte */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                \r
                                /* Write the request response byte */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r


@@ -181,16 +177,16 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                case Req_CheckAbortBulkOutStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r
                case Req_CheckAbortBulkOutStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r

-                               Endpoint_ClearSETUP();\r
-                               \r

                                /* Check that an ABORT BULK OUT transaction has been requested and that the request has completed */\r
                                /* Check that an ABORT BULK OUT transaction has been requested and that the request has completed */\r

-                               if (RequestInProgess != Req_InitiateAbortBulkOut)\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
                                  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;                          \r
                                else if (IsTMCBulkOUTReset)\r
                                  TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r

-                                 RequestInProgess = 0;                 \r
-                               \r
+                                 RequestInProgress = 0;        \r
+\r
+                               Endpoint_ClearSETUP();\r
+                                                               \r

                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                Endpoint_Write_Word_LE(0);\r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                Endpoint_Write_Word_LE(0);\r


@@ -204,10 +200,8 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                case Req_InitiateAbortBulkIn:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r
                case Req_InitiateAbortBulkIn:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r

-                               Endpoint_ClearSETUP();\r
-                               \r

                                /* Check that no split transaction is already in progress and the data transfer tag is valid */\r
                                /* Check that no split transaction is already in progress and the data transfer tag is valid */\r

-                               if (RequestInProgess != 0)\r
+                               if (RequestInProgress != 0)\r

                                {\r
                                        TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;                                \r
                                }\r
                                {\r
                                        TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;                                \r
                                }\r


@@ -221,8 +215,10 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                        IsTMCBulkINReset = true;\r
                                        \r
                                        /* Save the split request for later checking when a new request is received */\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

+\r
+                               Endpoint_ClearSETUP();\r

                                \r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                \r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r


@@ -236,16 +232,16 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                case Req_CheckAbortBulkInStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r
                case Req_CheckAbortBulkInStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))\r
                        {\r

-                               Endpoint_ClearSETUP();\r
-                               \r

                                /* Check that an ABORT BULK IN transaction has been requested and that the request has completed */\r
                                /* Check that an ABORT BULK IN transaction has been requested and that the request has completed */\r

-                               if (RequestInProgess != Req_InitiateAbortBulkIn)\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
                                  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;\r
                                else if (IsTMCBulkINReset)\r
                                  TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r

-                                 RequestInProgess = 0;\r
-                               \r
+                                 RequestInProgress = 0;\r
+\r
+                               Endpoint_ClearSETUP();\r
+                                                               \r

                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                Endpoint_Write_Word_LE(0);\r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                Endpoint_Write_Word_LE(0);\r


@@ -259,10 +255,8 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                case Req_InitiateClear:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
                case Req_InitiateClear:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r

-                               Endpoint_ClearSETUP();\r
-                               \r

                                /* Check that no split transaction is already in progress */\r
                                /* Check that no split transaction is already in progress */\r

-                               if (RequestInProgess != 0)\r
+                               if (RequestInProgress != 0)\r

                                {\r
                                        Endpoint_Write_Byte(TMC_STATUS_SPLIT_IN_PROGRESS);                              \r
                                }\r
                                {\r
                                        Endpoint_Write_Byte(TMC_STATUS_SPLIT_IN_PROGRESS);                              \r
                                }\r


@@ -273,8 +267,10 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                        IsTMCBulkOUTReset = true;\r
                                        \r
                                        /* Save the split request for later checking when a new request is received */\r
                                        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

+\r
+                               Endpoint_ClearSETUP();\r

                                \r
                                /* Write the request response byte */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                \r
                                /* Write the request response byte */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r


@@ -287,16 +283,16 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                case Req_CheckClearStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r
                case Req_CheckClearStatus:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\r

-                               Endpoint_ClearSETUP();\r
-                               \r

                                /* Check that a CLEAR transaction has been requested and that the request has completed */\r
                                /* Check that a CLEAR transaction has been requested and that the request has completed */\r

-                               if (RequestInProgess != Req_InitiateClear)\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
                                  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;                          \r
                                else if (IsTMCBulkINReset || IsTMCBulkOUTReset)\r
                                  TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r

-                                 RequestInProgess = 0;\r
-                               \r
+                                 RequestInProgress = 0;\r
+\r
+                               Endpoint_ClearSETUP();\r
+\r

                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                Endpoint_Write_Byte(0);\r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r
                                Endpoint_Write_Byte(0);\r


@@ -309,13 +305,10 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                case Req_GetCapabilities:\r
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
                        {\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
                                Endpoint_ClearOUT();\r
                        }\r
                        \r


@@ -329,36 +322,36 @@ void TMC_Task(void)
        /* Device must be connected and configured for the task to run */\r
        if (USB_DeviceState != DEVICE_STATE_Configured)\r
          return;\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
        \r

-       if (Endpoint_IsOUTReceived())\r
+       TMC_MessageHeader_t MessageHeader;\r
+       \r
+       /* Try to read in a TMC message from the interface, process if one is available */\r
+       if (ReadTMCHeader(&MessageHeader))\r

        {\r
        {\r

-               TMC_MessageHeader_t MessageHeader;\r
-               \r
-               Endpoint_Read_Stream_LE(&MessageHeader, sizeof(MessageHeader), StreamCallback_AbortOUTOnRequest);\r
-               CurrentTransferTag = MessageHeader.Tag;\r
+               /* Indicate busy */\r
+               LEDs_SetAllLEDs(LEDMASK_USB_BUSY);\r

                \r
                switch (MessageHeader.MessageID)\r
                {\r
                        case TMC_MESSAGEID_DEV_DEP_MSG_OUT:\r
                \r
                switch (MessageHeader.MessageID)\r
                {\r
                        case TMC_MESSAGEID_DEV_DEP_MSG_OUT:\r

-\r
+                               Endpoint_Discard_Stream(MessageHeader.TransferSize, StreamCallback_AbortOUTOnRequest);\r
+                               Endpoint_ClearOUT();\r

                                break;\r
                        case TMC_MESSAGEID_DEV_DEP_MSG_IN:\r
                                break;\r
                        case TMC_MESSAGEID_DEV_DEP_MSG_IN:\r

+                               Endpoint_ClearOUT();\r

 \r
 \r

-                               break;\r
-                       case TMC_MESSAGEID_DEV_VENDOR_OUT:\r
-\r
-                               break;\r
-                       case TMC_MESSAGEID_DEV_VENDOR_IN:\r
+                               MessageHeader.TransferSize = 3;\r
+                               WriteTMCHeader(&MessageHeader);\r

 \r
 \r

+                               Endpoint_Write_Stream_LE("TMC", 3, StreamCallback_AbortINOnRequest);\r
+                               Endpoint_ClearIN();\r

                                break;\r
                        default:\r
                                Endpoint_StallTransaction();\r
                                break;\r
                }\r
                                break;\r
                        default:\r
                                Endpoint_StallTransaction();\r
                                break;\r
                }\r

-               \r
-               Endpoint_ClearOUT();\r
+\r
+               LEDs_SetAllLEDs(LEDMASK_USB_READY);\r

        }\r
        \r
        /* All pending data has been processed - reset the data abort flags */\r
        }\r
        \r
        /* All pending data has been processed - reset the data abort flags */\r


@@ -366,6 +359,51 @@ void TMC_Task(void)
        IsTMCBulkOUTReset = false;\r
 }\r
 \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
+       /* 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
 /** 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


@@ -391,3 +429,4 @@ uint8_t StreamCallback_AbortOUTOnRequest(void)
        /* Continue with the current stream operation */\r
        return STREAMCALLBACK_Continue;\r
 }\r
        /* Continue with the current stream operation */\r
        return STREAMCALLBACK_Continue;\r
 }\r

+