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

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - 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     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  12 \r
  13     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 /**\r
  97  * Manages a queue of strings that are waiting to be displayed.  This is used to \r
  98  * ensure mutual exclusion of console output.\r
  99  *\r
 100  * A task wishing to display a message will call vPrintDisplayMessage (), with a \r
 101  * pointer to the string as the parameter. The pointer is posted onto the \r
 102  * xPrintQueue queue.\r
 103  *\r
 104  * The task spawned in main. c blocks on xPrintQueue.  When a message becomes \r
 105  * available it calls pcPrintGetNextMessage () to obtain a pointer to the next \r
 106  * string, then uses the functions defined in the portable layer FileIO. c to \r
 107  * display the message.\r
 108  *\r
 109  * <b>NOTE:</b>\r
 110  * Using console IO can disrupt real time performance - depending on the port.  \r
 111  * Standard C IO routines are not designed for real time applications.  While \r
 112  * standard IO is useful for demonstration and debugging an alternative method \r
 113  * should be used if you actually require console IO as part of your application.\r
 114  *\r
 115  * \page PrintC print.c\r
 116  * \ingroup DemoFiles\r
 117  * <HR>\r
 118  */\r
 119 \r
 120 /*\r
 121 Changes from V2.0.0\r
 122 \r
 123         + Delay periods are now specified using variables and constants of\r
 124           TickType_t rather than unsigned long.\r
 125 */\r
 126 \r
 127 #include <stdlib.h>\r
 128 \r
 129 /* Scheduler include files. */\r
 130 #include "FreeRTOS.h"\r
 131 #include "queue.h"\r
 132 \r
 133 /* Demo program include files. */\r
 134 #include "print.h"\r
 135 \r
 136 static QueueHandle_t xPrintQueue;\r
 137 \r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 void vPrintInitialise( void )\r
 141 {\r
 142 const unsigned portBASE_TYPE uxQueueSize = 20;\r
 143 \r
 144         /* Create the queue on which errors will be reported. */\r
 145         xPrintQueue = xQueueCreate( uxQueueSize, ( unsigned portBASE_TYPE ) sizeof( char * ) );\r
 146 }\r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 void vPrintDisplayMessage( const char * const * ppcMessageToSend )\r
 150 {\r
 151         #ifdef USE_STDIO\r
 152                 xQueueSend( xPrintQueue, ( void * ) ppcMessageToSend, ( TickType_t ) 0 );\r
 153         #else\r
 154         /* Stop warnings. */\r
 155                 ( void ) ppcMessageToSend;\r
 156         #endif\r
 157 }\r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 const char *pcPrintGetNextMessage( TickType_t xPrintRate )\r
 161 {\r
 162 char *pcMessage;\r
 163 \r
 164         if( xQueueReceive( xPrintQueue, &pcMessage, xPrintRate ) == pdPASS )\r
 165         {\r
 166                 return pcMessage;\r
 167         }\r
 168         else\r
 169         {\r
 170                 return NULL;\r
 171         }\r
 172 }\r
 173 \r
 174 \r