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

   1 /*\r
   2         FreeRTOS.org V4.3.0 - Copyright (C) 2003-2007 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         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 /**\r
  37  * Manages a queue of strings that are waiting to be displayed.  This is used to \r
  38  * ensure mutual exclusion of console output.\r
  39  *\r
  40  * A task wishing to display a message will call vPrintDisplayMessage (), with a \r
  41  * pointer to the string as the parameter. The pointer is posted onto the \r
  42  * xPrintQueue queue.\r
  43  *\r
  44  * The task spawned in main. c blocks on xPrintQueue.  When a message becomes \r
  45  * available it calls pcPrintGetNextMessage () to obtain a pointer to the next \r
  46  * string, then uses the functions defined in the portable layer FileIO. c to \r
  47  * display the message.\r
  48  *\r
  49  * <b>NOTE:</b>\r
  50  * Using console IO can disrupt real time performance - depending on the port.  \r
  51  * Standard C IO routines are not designed for real time applications.  While \r
  52  * standard IO is useful for demonstration and debugging an alternative method \r
  53  * should be used if you actually require console IO as part of your application.\r
  54  *\r
  55  * \page PrintC print.c\r
  56  * \ingroup DemoFiles\r
  57  * <HR>\r
  58  */\r
  59 \r
  60 /*\r
  61 Changes from V2.0.0\r
  62 \r
  63         + Delay periods are now specified using variables and constants of\r
  64           portTickType rather than unsigned portLONG.\r
  65 */\r
  66 \r
  67 #include <stdlib.h>\r
  68 \r
  69 /* Scheduler include files. */\r
  70 #include "FreeRTOS.h"\r
  71 #include "queue.h"\r
  72 \r
  73 /* Demo program include files. */\r
  74 #include "print.h"\r
  75 \r
  76 static xQueueHandle xPrintQueue;\r
  77 \r
  78 /*-----------------------------------------------------------*/\r
  79 \r
  80 void vPrintInitialise( void )\r
  81 {\r
  82 const unsigned portBASE_TYPE uxQueueSize = 20;\r
  83 \r
  84         /* Create the queue on which errors will be reported. */\r
  85         xPrintQueue = xQueueCreate( uxQueueSize, ( unsigned portBASE_TYPE ) sizeof( portCHAR * ) );\r
  86 }\r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend )\r
  90 {\r
  91         #ifdef USE_STDIO\r
  92                 xQueueSend( xPrintQueue, ( void * ) ppcMessageToSend, ( portTickType ) 0 );\r
  93         #else\r
  94         /* Stop warnings. */\r
  95                 ( void ) ppcMessageToSend;\r
  96         #endif\r
  97 }\r
  98 /*-----------------------------------------------------------*/\r
  99 \r
 100 const portCHAR *pcPrintGetNextMessage( portTickType xPrintRate )\r
 101 {\r
 102 portCHAR *pcMessage;\r
 103 \r
 104         if( xQueueReceive( xPrintQueue, &pcMessage, xPrintRate ) == pdPASS )\r
 105         {\r
 106                 return pcMessage;\r
 107         }\r
 108         else\r
 109         {\r
 110                 return NULL;\r
 111         }\r
 112 }\r
 113 \r
 114 \r