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

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