X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/9a97f16b07ea15e327b0d01be238b06623b033d6..9274610a483bb5ed1ea7ef752e4a6b2b1601e7a8:/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c

diff --git a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
index 711ca3fa8..040cb345d 100644
--- a/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
+++ b/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c
@@ -53,13 +53,13 @@ TMC_Capabilities_t Capabilities =
 	};
 
 /** Current TMC control request that is being processed */
-uint8_t RequestInProgess   = 0;
+uint8_t RequestInProgress = 0;
 
 /** Stream callback abort flag for bulk IN data */
-bool IsTMCBulkINReset      = false;
+bool IsTMCBulkINReset = false;
 
 /** Stream callback abort flag for bulk OUT data */
-bool IsTMCBulkOUTReset     = false;
+bool IsTMCBulkOUTReset = false;
 
 /** Last used tag value for data transfers */
 uint8_t CurrentTransferTag = 0;
@@ -153,7 +153,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 				Endpoint_ClearSETUP();
 				
 				/* Check that no split transaction is already in progress and the data transfer tag is valid */
-				if (RequestInProgess != 0)
+				if (RequestInProgress != 0)
 				{
 					TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;
 				}
@@ -167,7 +167,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 					IsTMCBulkOUTReset = true;
 					
 					/* Save the split request for later checking when a new request is received */
-					RequestInProgess = Req_InitiateAbortBulkOut;
+					RequestInProgress = Req_InitiateAbortBulkOut;
 				}
 				
 				/* Write the request response byte */
@@ -184,12 +184,12 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 				Endpoint_ClearSETUP();
 				
 				/* Check that an ABORT BULK OUT transaction has been requested and that the request has completed */
-				if (RequestInProgess != Req_InitiateAbortBulkOut)
+				if (RequestInProgress != Req_InitiateAbortBulkOut)
 				  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;				
 				else if (IsTMCBulkOUTReset)
 				  TMCRequestStatus = TMC_STATUS_PENDING;
 				else
-				  RequestInProgess = 0;			
+				  RequestInProgress = 0;			
 				
 				/* Write the request response bytes */
 				Endpoint_Write_Byte(TMCRequestStatus);
@@ -207,7 +207,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 				Endpoint_ClearSETUP();
 				
 				/* Check that no split transaction is already in progress and the data transfer tag is valid */
-				if (RequestInProgess != 0)
+				if (RequestInProgress != 0)
 				{
 					TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;				
 				}
@@ -221,7 +221,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 					IsTMCBulkINReset = true;
 					
 					/* Save the split request for later checking when a new request is received */
-					RequestInProgess = Req_InitiateAbortBulkIn;
+					RequestInProgress = Req_InitiateAbortBulkIn;
 				}
 				
 				/* Write the request response bytes */
@@ -239,12 +239,12 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 				Endpoint_ClearSETUP();
 				
 				/* Check that an ABORT BULK IN transaction has been requested and that the request has completed */
-				if (RequestInProgess != Req_InitiateAbortBulkIn)
+				if (RequestInProgress != Req_InitiateAbortBulkIn)
 				  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;
 				else if (IsTMCBulkINReset)
 				  TMCRequestStatus = TMC_STATUS_PENDING;
 				else
-				  RequestInProgess = 0;
+				  RequestInProgress = 0;
 				
 				/* Write the request response bytes */
 				Endpoint_Write_Byte(TMCRequestStatus);
@@ -262,7 +262,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 				Endpoint_ClearSETUP();
 				
 				/* Check that no split transaction is already in progress */
-				if (RequestInProgess != 0)
+				if (RequestInProgress != 0)
 				{
 					Endpoint_Write_Byte(TMC_STATUS_SPLIT_IN_PROGRESS);				
 				}
@@ -273,7 +273,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 					IsTMCBulkOUTReset = true;
 					
 					/* Save the split request for later checking when a new request is received */
-					RequestInProgess = Req_InitiateClear;
+					RequestInProgress = Req_InitiateClear;
 				}
 				
 				/* Write the request response byte */
@@ -290,12 +290,12 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 				Endpoint_ClearSETUP();
 				
 				/* Check that a CLEAR transaction has been requested and that the request has completed */
-				if (RequestInProgess != Req_InitiateClear)
+				if (RequestInProgress != Req_InitiateClear)
 				  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;				
 				else if (IsTMCBulkINReset || IsTMCBulkOUTReset)
 				  TMCRequestStatus = TMC_STATUS_PENDING;
 				else
-				  RequestInProgess = 0;
+				  RequestInProgress = 0;
 				
 				/* Write the request response bytes */
 				Endpoint_Write_Byte(TMCRequestStatus);
@@ -332,7 +332,7 @@ void TMC_Task(void)
 	
 	TMC_MessageHeader_t MessageHeader;
 	
-	/* Check if a TMC packet has been received */
+	/* Try to read in a TMC message from the interface, process if one is available */
 	if (ReadTMCHeader(&MessageHeader))
 	{
 		/* Indicate busy */
@@ -366,6 +366,12 @@ void TMC_Task(void)
 	IsTMCBulkOUTReset = false;
 }
 
+/** Attempts to read in the TMC message header from the TMC interface.
+ *
+ *  \param[out] MessageHeader  Pointer to a location where the read header (if any) should be stored
+ *
+ *  \return Boolean true if a header was read, false otherwise
+ */
 bool ReadTMCHeader(TMC_MessageHeader_t* const MessageHeader)
 {
 	/* Select the Data Out endpoint */
@@ -382,7 +388,7 @@ bool ReadTMCHeader(TMC_MessageHeader_t* const MessageHeader)
 	CurrentTransferTag = MessageHeader->Tag;
 	
 	/* Indicate if the command has been aborted or not */
-	return !IsTMCBulkOUTReset;
+	return !(IsTMCBulkOUTReset);
 }
 
 bool WriteTMCHeader(TMC_MessageHeader_t* const MessageHeader)
@@ -402,7 +408,7 @@ bool WriteTMCHeader(TMC_MessageHeader_t* const MessageHeader)
 	Endpoint_Write_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), StreamCallback_AbortINOnRequest);
 
 	/* Indicate if the command has been aborted or not */
-	return !IsTMCBulkINReset;
+	return !(IsTMCBulkINReset);
 }
 
 /** Stream callback function for the Endpoint stream write functions. This callback will abort the current stream transfer