begriffs open source - freertos/blob - Demo/Common/Full/print.c

   1 /*\r
   2         FreeRTOS.org V5.2.0 - Copyright (C) 2003-2009 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify it \r
   7         under the terms of the GNU General Public License (version 2) as published\r
   8         by the Free Software Foundation and modified by the FreeRTOS exception.\r
   9 \r
  10         FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT\r
  11         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or \r
  12         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for \r
  13         more details.\r
  14 \r
  15         You should have received a copy of the GNU General Public License along \r
  16         with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59 \r
  17         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  18 \r
  19         A special exception to the GPL is included to allow you to distribute a \r
  20         combined work that includes FreeRTOS.org without being obliged to provide\r
  21         the source code for any proprietary components.  See the licensing section\r
  22         of http://www.FreeRTOS.org for full details.\r
  23 \r
  24 \r
  25         ***************************************************************************\r
  26         *                                                                         *\r
  27         * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  28         *                                                                         *\r
  29         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  30         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  31         * explains numerous examples that are written using the FreeRTOS API.     *\r
  32         * Full source code for all the examples is provided in an accompanying    *\r
  33         * .zip file.                                                              *\r
  34         *                                                                         *\r
  35         ***************************************************************************\r
  36 \r
  37         1 tab == 4 spaces!\r
  38 \r
  39         Please ensure to read the configuration and relevant port sections of the\r
  40         online documentation.\r
  41 \r
  42         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  43         contact details.\r
  44 \r
  45         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  46         critical systems.\r
  47 \r
  48         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  49         licensing and training services.\r
  50 */\r
  51 \r
  52 /**\r
  53  * Manages a queue of strings that are waiting to be displayed.  This is used to \r
  54  * ensure mutual exclusion of console output.\r
  55  *\r
  56  * A task wishing to display a message will call vPrintDisplayMessage (), with a \r
  57  * pointer to the string as the parameter. The pointer is posted onto the \r
  58  * xPrintQueue queue.\r
  59  *\r
  60  * The task spawned in main. c blocks on xPrintQueue.  When a message becomes \r
  61  * available it calls pcPrintGetNextMessage () to obtain a pointer to the next \r
  62  * string, then uses the functions defined in the portable layer FileIO. c to \r
  63  * display the message.\r
  64  *\r
  65  * <b>NOTE:</b>\r
  66  * Using console IO can disrupt real time performance - depending on the port.  \r
  67  * Standard C IO routines are not designed for real time applications.  While \r
  68  * standard IO is useful for demonstration and debugging an alternative method \r
  69  * should be used if you actually require console IO as part of your application.\r
  70  *\r
  71  * \page PrintC print.c\r
  72  * \ingroup DemoFiles\r
  73  * <HR>\r
  74  */\r
  75 \r
  76 /*\r
  77 Changes from V2.0.0\r
  78 \r
  79         + Delay periods are now specified using variables and constants of\r
  80           portTickType rather than unsigned portLONG.\r
  81 */\r
  82 \r
  83 #include <stdlib.h>\r
  84 \r
  85 /* Scheduler include files. */\r
  86 #include "FreeRTOS.h"\r
  87 #include "queue.h"\r
  88 \r
  89 /* Demo program include files. */\r
  90 #include "print.h"\r
  91 \r
  92 static xQueueHandle xPrintQueue;\r
  93 \r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 void vPrintInitialise( void )\r
  97 {\r
  98 const unsigned portBASE_TYPE uxQueueSize = 20;\r
  99 \r
 100         /* Create the queue on which errors will be reported. */\r
 101         xPrintQueue = xQueueCreate( uxQueueSize, ( unsigned portBASE_TYPE ) sizeof( portCHAR * ) );\r
 102 }\r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend )\r
 106 {\r
 107         #ifdef USE_STDIO\r
 108                 xQueueSend( xPrintQueue, ( void * ) ppcMessageToSend, ( portTickType ) 0 );\r
 109         #else\r
 110         /* Stop warnings. */\r
 111                 ( void ) ppcMessageToSend;\r
 112         #endif\r
 113 }\r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 const portCHAR *pcPrintGetNextMessage( portTickType xPrintRate )\r
 117 {\r
 118 portCHAR *pcMessage;\r
 119 \r
 120         if( xQueueReceive( xPrintQueue, &pcMessage, xPrintRate ) == pdPASS )\r
 121         {\r
 122                 return pcMessage;\r
 123         }\r
 124         else\r
 125         {\r
 126                 return NULL;\r
 127         }\r
 128 }\r
 129 \r
 130 \r