git.sur5r.net Git - freertos/blob - Demo/Common/Full/print.c

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