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

   1 /*\r
   2     FreeRTOS V7.2.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43     \r
  44     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /**\r
  68  * Manages a queue of strings that are waiting to be displayed.  This is used to \r
  69  * ensure mutual exclusion of console output.\r
  70  *\r
  71  * A task wishing to display a message will call vPrintDisplayMessage (), with a \r
  72  * pointer to the string as the parameter. The pointer is posted onto the \r
  73  * xPrintQueue queue.\r
  74  *\r
  75  * The task spawned in main. c blocks on xPrintQueue.  When a message becomes \r
  76  * available it calls pcPrintGetNextMessage () to obtain a pointer to the next \r
  77  * string, then uses the functions defined in the portable layer FileIO. c to \r
  78  * display the message.\r
  79  *\r
  80  * <b>NOTE:</b>\r
  81  * Using console IO can disrupt real time performance - depending on the port.  \r
  82  * Standard C IO routines are not designed for real time applications.  While \r
  83  * standard IO is useful for demonstration and debugging an alternative method \r
  84  * should be used if you actually require console IO as part of your application.\r
  85  *\r
  86  * \page PrintC print.c\r
  87  * \ingroup DemoFiles\r
  88  * <HR>\r
  89  */\r
  90 \r
  91 /*\r
  92 Changes from V2.0.0\r
  93 \r
  94         + Delay periods are now specified using variables and constants of\r
  95           portTickType rather than unsigned long.\r
  96 */\r
  97 \r
  98 #include <stdlib.h>\r
  99 \r
 100 /* Scheduler include files. */\r
 101 #include "FreeRTOS.h"\r
 102 #include "queue.h"\r
 103 \r
 104 /* Demo program include files. */\r
 105 #include "print.h"\r
 106 \r
 107 static xQueueHandle xPrintQueue;\r
 108 \r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 void vPrintInitialise( void )\r
 112 {\r
 113 const unsigned portBASE_TYPE uxQueueSize = 20;\r
 114 \r
 115         /* Create the queue on which errors will be reported. */\r
 116         xPrintQueue = xQueueCreate( uxQueueSize, ( unsigned portBASE_TYPE ) sizeof( char * ) );\r
 117 }\r
 118 /*-----------------------------------------------------------*/\r
 119 \r
 120 void vPrintDisplayMessage( const char * const * ppcMessageToSend )\r
 121 {\r
 122         #ifdef USE_STDIO\r
 123                 xQueueSend( xPrintQueue, ( void * ) ppcMessageToSend, ( portTickType ) 0 );\r
 124         #else\r
 125         /* Stop warnings. */\r
 126                 ( void ) ppcMessageToSend;\r
 127         #endif\r
 128 }\r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 const char *pcPrintGetNextMessage( portTickType xPrintRate )\r
 132 {\r
 133 char *pcMessage;\r
 134 \r
 135         if( xQueueReceive( xPrintQueue, &pcMessage, xPrintRate ) == pdPASS )\r
 136         {\r
 137                 return pcMessage;\r
 138         }\r
 139         else\r
 140         {\r
 141                 return NULL;\r
 142         }\r
 143 }\r
 144 \r
 145 \r