Add first version of alternative API.

git-svn-id: https://freertos.svn.sourceforge.net/svnroot/freertos/trunk@123 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

1 files changed, 237 insertions, 0 deletions

diff --git a/Demo/Common/Minimal/AltPollQ.c b/Demo/Common/Minimal/AltPollQ.c
new file mode 100644
index 00000000..52f46bf5
--- /dev/null
+++ b/Demo/Common/Minimal/AltPollQ.c
@@ -0,0 +1,237 @@
+/*

+	FreeRTOS.org V4.6.1 - Copyright (C) 2003-2007 Richard Barry.

+

+	This file is part of the FreeRTOS.org distribution.

+

+	FreeRTOS.org is free software; you can redistribute it and/or modify

+	it under the terms of the GNU General Public License as published by

+	the Free Software Foundation; either version 2 of the License, or

+	(at your option) any later version.

+

+	FreeRTOS.org is distributed in the hope that it will be useful,

+	but WITHOUT ANY WARRANTY; without even the implied warranty of

+	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+	GNU General Public License for more details.

+

+	You should have received a copy of the GNU General Public License

+	along with FreeRTOS.org; if not, write to the Free Software

+	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+

+	A special exception to the GPL can be applied should you wish to distribute

+	a combined work that includes FreeRTOS.org, without being obliged to provide

+	the source code for any proprietary components.  See the licensing section

+	of http://www.FreeRTOS.org for full details of how and when the exception

+	can be applied.

+

+	***************************************************************************

+	See http://www.FreeRTOS.org for documentation, latest information, license

+	and contact details.  Please ensure to read the configuration and relevant

+	port sections of the online documentation.

+

+	Also see http://www.SafeRTOS.com a version that has been certified for use

+	in safety critical systems, plus commercial licensing, development and

+	support options.

+	***************************************************************************

+*/

+

+/*

+ * This is a version of PollQ.c that uses the alternative (Alt) API.

+ * 

+ * Creates two tasks that communicate over a single queue.  One task acts as a

+ * producer, the other a consumer.

+ *

+ * The producer loops for three iteration, posting an incrementing number onto the

+ * queue each cycle.  It then delays for a fixed period before doing exactly the

+ * same again.

+ *

+ * The consumer loops emptying the queue.  Each item removed from the queue is

+ * checked to ensure it contains the expected value.  When the queue is empty it

+ * blocks for a fixed period, then does the same again.

+ *

+ * All queue access is performed without blocking.  The consumer completely empties

+ * the queue each time it runs so the producer should never find the queue full.

+ *

+ * An error is flagged if the consumer obtains an unexpected value or the producer

+ * find the queue is full.

+ */

+

+/*

+Changes from V2.0.0

+

+	+ Delay periods are now specified using variables and constants of

+	  portTickType rather than unsigned portLONG.

+*/

+

+#include <stdlib.h>

+

+/* Scheduler include files. */

+#include "FreeRTOS.h"

+#include "task.h"

+#include "queue.h"

+

+/* Demo program include files. */

+#include "AltPollQ.h"

+

+#define pollqSTACK_SIZE			configMINIMAL_STACK_SIZE

+#define pollqQUEUE_SIZE			( 10 )

+#define pollqPRODUCER_DELAY		( ( portTickType ) 200 / portTICK_RATE_MS )

+#define pollqCONSUMER_DELAY		( pollqPRODUCER_DELAY - ( portTickType ) ( 20 / portTICK_RATE_MS ) )

+#define pollqNO_DELAY			( ( portTickType ) 0 )

+#define pollqVALUES_TO_PRODUCE	( ( signed portBASE_TYPE ) 3 )

+#define pollqINITIAL_VALUE		( ( signed portBASE_TYPE ) 0 )

+

+/* The task that posts the incrementing number onto the queue. */

+static portTASK_FUNCTION_PROTO( vPolledQueueProducer, pvParameters );

+

+/* The task that empties the queue. */

+static portTASK_FUNCTION_PROTO( vPolledQueueConsumer, pvParameters );

+

+/* Variables that are used to check that the tasks are still running with no

+errors. */

+static volatile signed portBASE_TYPE xPollingConsumerCount = pollqINITIAL_VALUE, xPollingProducerCount = pollqINITIAL_VALUE;

+

+/*-----------------------------------------------------------*/

+

+void vStartAltPolledQueueTasks( unsigned portBASE_TYPE uxPriority )

+{

+static xQueueHandle xPolledQueue;

+

+	/* Create the queue used by the producer and consumer. */

+	xPolledQueue = xQueueCreate( pollqQUEUE_SIZE, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );

+

+	/* Spawn the producer and consumer. */

+	xTaskCreate( vPolledQueueConsumer, ( signed portCHAR * ) "QConsNB", pollqSTACK_SIZE, ( void * ) &xPolledQueue, uxPriority, ( xTaskHandle * ) NULL );

+	xTaskCreate( vPolledQueueProducer, ( signed portCHAR * ) "QProdNB", pollqSTACK_SIZE, ( void * ) &xPolledQueue, uxPriority, ( xTaskHandle * ) NULL );

+}

+/*-----------------------------------------------------------*/

+

+static portTASK_FUNCTION( vPolledQueueProducer, pvParameters )

+{

+unsigned portSHORT usValue = ( unsigned portSHORT ) 0;

+signed portBASE_TYPE xError = pdFALSE, xLoop;

+

+	#ifdef USE_STDIO

+	void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );

+	

+		const portCHAR * const pcTaskStartMsg = "Alt polling queue producer task started.\r\n";

+

+		/* Queue a message for printing to say the task has started. */

+		vPrintDisplayMessage( &pcTaskStartMsg );

+	#endif

+

+	for( ;; )

+	{		

+		for( xLoop = 0; xLoop < pollqVALUES_TO_PRODUCE; xLoop++ )

+		{

+			/* Send an incrementing number on the queue without blocking. */

+			if( xQueueAltSendToBack( *( ( xQueueHandle * ) pvParameters ), ( void * ) &usValue, pollqNO_DELAY ) != pdPASS )

+			{

+				/* We should never find the queue full so if we get here there

+				has been an error. */

+				xError = pdTRUE;

+			}

+			else

+			{

+				if( xError == pdFALSE )

+				{

+					/* If an error has ever been recorded we stop incrementing the

+					check variable. */

+					portENTER_CRITICAL();

+						xPollingProducerCount++;

+					portEXIT_CRITICAL();

+				}

+

+				/* Update the value we are going to post next time around. */

+				usValue++;

+			}

+		}

+

+		/* Wait before we start posting again to ensure the consumer runs and

+		empties the queue. */

+		vTaskDelay( pollqPRODUCER_DELAY );

+	}

+}  /*lint !e818 Function prototype must conform to API. */

+/*-----------------------------------------------------------*/

+

+static portTASK_FUNCTION( vPolledQueueConsumer, pvParameters )

+{

+unsigned portSHORT usData, usExpectedValue = ( unsigned portSHORT ) 0;

+signed portBASE_TYPE xError = pdFALSE;

+

+	#ifdef USE_STDIO

+	void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );

+	

+		const portCHAR * const pcTaskStartMsg = "Alt blocking queue consumer task started.\r\n";

+

+		/* Queue a message for printing to say the task has started. */

+		vPrintDisplayMessage( &pcTaskStartMsg );

+	#endif

+

+	for( ;; )

+	{		

+		/* Loop until the queue is empty. */

+		while( uxQueueMessagesWaiting( *( ( xQueueHandle * ) pvParameters ) ) )

+		{

+			if( xQueueAltReceive( *( ( xQueueHandle * ) pvParameters ), &usData, pollqNO_DELAY ) == pdPASS )

+			{

+				if( usData != usExpectedValue )

+				{

+					/* This is not what we expected to receive so an error has

+					occurred. */

+					xError = pdTRUE;

+

+					/* Catch-up to the value we received so our next expected

+					value should again be correct. */

+					usExpectedValue = usData;

+				}

+				else

+				{

+					if( xError == pdFALSE )

+					{

+						/* Only increment the check variable if no errors have

+						occurred. */

+						portENTER_CRITICAL();

+							xPollingConsumerCount++;

+						portEXIT_CRITICAL();

+					}

+				}

+

+				/* Next time round we would expect the number to be one higher. */

+				usExpectedValue++;

+			}

+		}

+

+		/* Now the queue is empty we block, allowing the producer to place more

+		items in the queue. */

+		vTaskDelay( pollqCONSUMER_DELAY );

+	}

+} /*lint !e818 Function prototype must conform to API. */

+/*-----------------------------------------------------------*/

+

+/* This is called to check that all the created tasks are still running with no errors. */

+portBASE_TYPE xAreAltPollingQueuesStillRunning( void )

+{

+portBASE_TYPE xReturn;

+

+	/* Check both the consumer and producer poll count to check they have both

+	been changed since out last trip round.  We do not need a critical section

+	around the check variables as this is called from a higher priority than

+	the other tasks that access the same variables. */

+	if( ( xPollingConsumerCount == pollqINITIAL_VALUE ) ||

+		( xPollingProducerCount == pollqINITIAL_VALUE )

+	  )

+	{

+		xReturn = pdFALSE;

+	}

+	else

+	{

+		xReturn = pdTRUE;

+	}

+

+	/* Set the check variables back down so we know if they have been

+	incremented the next time around. */

+	xPollingConsumerCount = pollqINITIAL_VALUE;

+	xPollingProducerCount = pollqINITIAL_VALUE;

+

+	return xReturn;

+}