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

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