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 040cb34..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


@@ -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,8 +146,6 @@ 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
                                if (RequestInProgress != 0)\r
                                {\r
                                /* Check that no split transaction is already in progress and the data transfer tag is valid */\r
                                if (RequestInProgress != 0)\r
                                {\r


@@ -169,6 +163,8 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                        /* Save the split request for later checking when a new request is received */\r
                                        RequestInProgress = Req_InitiateAbortBulkOut;\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_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
                                if (RequestInProgress != Req_InitiateAbortBulkOut)\r
                                  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;                          \r
                                else if (IsTMCBulkOUTReset)\r
                                  TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\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
+                                 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,8 +200,6 @@ 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
                                if (RequestInProgress != 0)\r
                                {\r
                                /* Check that no split transaction is already in progress and the data transfer tag is valid */\r
                                if (RequestInProgress != 0)\r
                                {\r


@@ -223,6 +217,8 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                        /* Save the split request for later checking when a new request is received */\r
                                        RequestInProgress = Req_InitiateAbortBulkIn;\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_Byte(TMCRequestStatus);\r
                                \r
                                /* Write the request response bytes */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r


@@ -236,8 +232,6 @@ 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
                                if (RequestInProgress != Req_InitiateAbortBulkIn)\r
                                  TMCRequestStatus = TMC_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


@@ -245,7 +239,9 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                  TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r
                                  RequestInProgress = 0;\r
                                  TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r
                                  RequestInProgress = 0;\r

-                               \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,8 +255,6 @@ 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
                                if (RequestInProgress != 0)\r
                                {\r
                                /* Check that no split transaction is already in progress */\r
                                if (RequestInProgress != 0)\r
                                {\r


@@ -275,6 +269,8 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                        /* Save the split request for later checking when a new request is received */\r
                                        RequestInProgress = Req_InitiateClear;\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_Byte(TMCRequestStatus);\r
                                \r
                                /* Write the request response byte */\r
                                Endpoint_Write_Byte(TMCRequestStatus);\r


@@ -287,8 +283,6 @@ 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
                                if (RequestInProgress != Req_InitiateClear)\r
                                  TMCRequestStatus = TMC_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


@@ -296,7 +290,9 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                  TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r
                                  RequestInProgress = 0;\r
                                  TMCRequestStatus = TMC_STATUS_PENDING;\r
                                else\r
                                  RequestInProgress = 0;\r

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


@@ -436,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

+