]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/PIC18_WizC/Demo2/main.c
Update version number in readiness for V10.3.0 release. Sync SVN with reviewed releas...
[freertos] / FreeRTOS / Demo / PIC18_WizC / Demo2 / main.c
1 /*\r
2  * FreeRTOS Kernel V10.3.0\r
3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
6  * this software and associated documentation files (the "Software"), to deal in\r
7  * the Software without restriction, including without limitation the rights to\r
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
10  * subject to the following conditions:\r
11  *\r
12  * The above copyright notice and this permission notice shall be included in all\r
13  * copies or substantial portions of the Software.\r
14  *\r
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
21  *\r
22  * http://www.FreeRTOS.org\r
23  * http://aws.amazon.com/freertos\r
24  *\r
25  * 1 tab == 4 spaces!\r
26  */\r
27 \r
28 /*\r
29 Changes from V3.0.0\r
30 \r
31 Changes from V3.0.1\r
32 */\r
33 \r
34 /*\r
35  * Instead of the normal single demo application, the PIC18F demo is split\r
36  * into several smaller programs of which this is the second.  This enables the\r
37  * demo's to be executed on the RAM limited PIC-devices.\r
38  *\r
39  * The Demo2 project is configured for a PIC18F4620 device.  Main.c starts 12\r
40  * tasks (including the idle task). See the indicated files in the demo/common\r
41  * directory for more information.\r
42  *\r
43  * demo/common/minimal/integer.c:       Creates 1 task\r
44  * demo/common/minimal/PollQ.c:         Creates 2 tasks\r
45  * demo/common/minimal/semtest.c:       Creates 4 tasks\r
46  * demo/common/minimal/flash.c:         Creates 3 tasks\r
47  *\r
48  * Main.c also creates a check task.  This periodically checks that all the\r
49  * other tasks are still running and have not experienced any unexpected\r
50  * results.  If all the other tasks are executing correctly an LED is flashed\r
51  * once every mainCHECK_PERIOD milliseconds.  If any of the tasks have not\r
52  * executed, or report an error, the frequency of the LED flash will increase\r
53  * to mainERROR_FLASH_RATE.\r
54  *\r
55  * On entry to main an 'X' is transmitted.  Monitoring the serial port using a\r
56  * dumb terminal allows for verification that the device is not continuously\r
57  * being reset (no more than one 'X' should be transmitted).\r
58  *\r
59  * http://www.FreeRTOS.org contains important information on the use of the\r
60  * wizC PIC18F port.\r
61  */\r
62 \r
63 /* Scheduler include files. */\r
64 #include <FreeRTOS.h>\r
65 #include <task.h>\r
66 \r
67 /* Demo app include files. */\r
68 #include "integer.h"\r
69 #include "PollQ.h"\r
70 #include "semtest.h"\r
71 #include "flash.h"\r
72 #include "partest.h"\r
73 #include "serial.h"\r
74 \r
75 /* The period between executions of the check task before and after an error\r
76 has been discovered.  If an error has been discovered the check task runs\r
77 more frequently - increasing the LED flash rate. */\r
78 #define mainNO_ERROR_CHECK_PERIOD       ( ( TickType_t ) 10000 / portTICK_PERIOD_MS )\r
79 #define mainERROR_CHECK_PERIOD          ( ( TickType_t )  1000 / portTICK_PERIOD_MS )\r
80 #define mainCHECK_TASK_LED                      ( ( unsigned char ) 3 )\r
81 \r
82 /* Priority definitions for some of the tasks.  Other tasks just use the idle\r
83 priority. */\r
84 #define mainCHECK_TASK_PRIORITY ( tskIDLE_PRIORITY + ( unsigned char ) 3 )\r
85 #define mainLED_FLASH_PRIORITY  ( tskIDLE_PRIORITY + ( unsigned char ) 2 )\r
86 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + ( unsigned char ) 1 )\r
87 #define mainSEM_TEST_PRIORITY   ( tskIDLE_PRIORITY + ( unsigned char ) 1 )\r
88 #define mainINTEGER_PRIORITY    ( tskIDLE_PRIORITY + ( unsigned char ) 0 )\r
89 \r
90 /* Constants required for the communications.  Only one character is ever\r
91 transmitted. */\r
92 #define mainCOMMS_QUEUE_LENGTH          ( ( unsigned char ) 5 )\r
93 #define mainNO_BLOCK                            ( ( TickType_t ) 0 )\r
94 #define mainBAUD_RATE                           ( ( unsigned long ) 57600 )\r
95 \r
96 /*\r
97  * The task function for the "Check" task.\r
98  */\r
99 static portTASK_FUNCTION_PROTO( vErrorChecks, pvParameters );\r
100 \r
101 /*\r
102  * Checks the unique counts of other tasks to ensure they are still operational.\r
103  * Returns pdTRUE if an error is detected, otherwise pdFALSE.\r
104  */\r
105 static char prvCheckOtherTasksAreStillRunning( void );\r
106 \r
107 /*-----------------------------------------------------------*/\r
108 \r
109 /* Creates the tasks, then starts the scheduler. */\r
110 void main( void )\r
111 {\r
112         /* Initialise the required hardware. */\r
113         vParTestInitialise();\r
114 \r
115         /* Send a character so we have some visible feedback of a reset. */\r
116         xSerialPortInitMinimal( mainBAUD_RATE, mainCOMMS_QUEUE_LENGTH );\r
117         xSerialPutChar( NULL, 'X', mainNO_BLOCK );\r
118 \r
119         /* Start a few of the standard demo tasks found in the demo\common directory. */\r
120         vStartIntegerMathTasks( mainINTEGER_PRIORITY);\r
121         vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );\r
122         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
123         vStartLEDFlashTasks( mainLED_FLASH_PRIORITY );\r
124 \r
125         /* Start the check task defined in this file. */\r
126         xTaskCreate( vErrorChecks, "Check", portMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
127 \r
128         /* Start the scheduler.  Will never return here. */\r
129         vTaskStartScheduler();\r
130 \r
131         while(1)        /* This point should never be reached. */\r
132         {\r
133         }\r
134 }\r
135 /*-----------------------------------------------------------*/\r
136 \r
137 static portTASK_FUNCTION( vErrorChecks, pvParameters )\r
138 {\r
139 TickType_t xLastCheckTime;\r
140 TickType_t xDelayTime = mainNO_ERROR_CHECK_PERIOD;\r
141 char cErrorOccurred;\r
142 \r
143         /* We need to initialise xLastCheckTime prior to the first call to\r
144         vTaskDelayUntil(). */\r
145         xLastCheckTime = xTaskGetTickCount();\r
146 \r
147         /* Cycle for ever, delaying then checking all the other tasks are still\r
148         operating without error. */\r
149         for( ;; )\r
150         {\r
151                 /* Wait until it is time to check the other tasks again. */\r
152                 vTaskDelayUntil( &xLastCheckTime, xDelayTime );\r
153 \r
154                 /* Check all the other tasks are running, and running without ever\r
155                 having an error. */\r
156                 cErrorOccurred = prvCheckOtherTasksAreStillRunning();\r
157 \r
158                 /* If an error was detected increase the frequency of the LED flash. */\r
159                 if( cErrorOccurred == pdTRUE )\r
160                 {\r
161                         xDelayTime = mainERROR_CHECK_PERIOD;\r
162                 }\r
163 \r
164                 /* Flash the LED for visual feedback. */\r
165                 vParTestToggleLED( mainCHECK_TASK_LED );\r
166         }\r
167 }\r
168 /*-----------------------------------------------------------*/\r
169 \r
170 static char prvCheckOtherTasksAreStillRunning( void )\r
171 {\r
172         char cErrorHasOccurred = ( char ) pdFALSE;\r
173 \r
174         if( xAreIntegerMathsTaskStillRunning() != pdTRUE )\r
175         {\r
176                 cErrorHasOccurred = ( char ) pdTRUE;\r
177         }\r
178 \r
179         if( xArePollingQueuesStillRunning() != pdTRUE )\r
180         {\r
181                 cErrorHasOccurred = ( char ) pdTRUE;\r
182         }\r
183 \r
184         if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
185         {\r
186                 cErrorHasOccurred = ( char ) pdTRUE;\r
187         }\r
188 \r
189         return cErrorHasOccurred;\r
190 }\r
191 /*-----------------------------------------------------------*/\r
192 \r
193 \r