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

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