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