git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/FreeRTOS_Plus_FAT_SL_and_CLI_Windows_Simulator/main.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  *\r
  98  * This demo is described on the following web page:\r
  99  * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_FAT_SL/Demos/File_System_Win32_Simulator_demo.shtml\r
 100  *\r
 101  ******************************************************************************/\r
 102 \r
 103 /* Standard includes. */\r
 104 #include <stdio.h>\r
 105 #include <stdint.h>\r
 106 \r
 107 /* FreeRTOS includes. */\r
 108 #include <FreeRTOS.h>\r
 109 #include "task.h"\r
 110 #include "queue.h"\r
 111 #include "semphr.h"\r
 112 \r
 113 /* File system includes. */\r
 114 #include "config_fat_sl.h"\r
 115 \r
 116 /* Priorities at which the tasks are created. */\r
 117 #define mainUDP_CLI_TASK_PRIORITY                       ( tskIDLE_PRIORITY )\r
 118 \r
 119 /*-----------------------------------------------------------*/\r
 120 \r
 121 /*\r
 122  * Register the generic commands that can be used with FreeRTOS+CLI.\r
 123  */\r
 124 extern void vRegisterSampleCLICommands( void );\r
 125 \r
 126 /*\r
 127  * Register the file system commands that can be used with FreeRTOS+CLI.\r
 128  */\r
 129 extern void vRegisterFileSystemCLICommands( void );\r
 130 \r
 131 /*\r
 132  * The task that implements the UDP command interpreter using FreeRTOS+CLI.\r
 133  */\r
 134 extern void vUDPCommandInterpreterTask( void *pvParameters );\r
 135 \r
 136 /*\r
 137  * Creates and verifies different files on the volume, demonstrating the use of\r
 138  * various different API functions.\r
 139  */\r
 140 extern void vCreateAndVerifySampleFiles( void );\r
 141 \r
 142 /*-----------------------------------------------------------*/\r
 143 \r
 144 /******************************************************************************\r
 145  *\r
 146  * This demo is described on the following web page:\r
 147  * http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_FAT_SL/Demos/File_System_Win32_Simulator_demo.shtml\r
 148  *\r
 149  ******************************************************************************/\r
 150 \r
 151 int main( void )\r
 152 {\r
 153 const uint32_t ulLongTime_ms = 250UL;\r
 154 \r
 155         /* If the file system is only going to be accessed from one task then\r
 156         F_FS_THREAD_AWARE can be set to 0 and the set of example files are created\r
 157         before the RTOS scheduler is started.  If the file system is going to be\r
 158         access from more than one task then F_FS_THREAD_AWARE must be set to 1 and\r
 159         the     set of sample files are created from the idle task hook function\r
 160         vApplicationIdleHook() - which is defined in this file. */\r
 161         #if F_FS_THREAD_AWARE == 0\r
 162         {\r
 163                 /* Initialise the drive and file system, then create a few example\r
 164                 files.  The output from this function just goes to the stdout window,\r
 165                 allowing the output to be viewed when the UDP command console is not\r
 166                 connected. */\r
 167                 vCreateAndVerifySampleFiles();\r
 168         }\r
 169         #endif\r
 170 \r
 171         /* Register generic commands with the FreeRTOS+CLI command interpreter. */\r
 172         vRegisterSampleCLICommands();\r
 173 \r
 174         /* Register file system related commands with the FreeRTOS+CLI command\r
 175         interpreter. */\r
 176         vRegisterFileSystemCLICommands();\r
 177 \r
 178         /* Create the task that handles the CLI on a UDP port.  The port number\r
 179         is set using the configUDP_CLI_PORT_NUMBER setting in FreeRTOSConfig.h. */\r
 180         xTaskCreate( vUDPCommandInterpreterTask,        /* The function that implements the command interpreter IO handling. */\r
 181                                 "CLI",                                                  /* The name of the task - just to assist debugging. */\r
 182                                 configMINIMAL_STACK_SIZE, NULL, /* The size of the stack allocated to the task. */\r
 183                                 mainUDP_CLI_TASK_PRIORITY,              /* The priority at which the task will run. */\r
 184                                 NULL );                                                 /* A handle to the task is not required, so NULL is passed. */\r
 185 \r
 186         /* Start the RTOS scheduler. */\r
 187         vTaskStartScheduler();\r
 188 \r
 189         /* If all is well, the scheduler will now be running, and the following\r
 190         line will never be reached.  If the following line does execute, then\r
 191         there was insufficient FreeRTOS heap memory available for the idle and/or\r
 192         timer tasks     to be created.  See the memory management section on the\r
 193         FreeRTOS web site for more details (this is standard text that is not not\r
 194         really applicable to the Win32 simulator port). */\r
 195         for( ;; )\r
 196         {\r
 197                 Sleep( ulLongTime_ms );\r
 198         }\r
 199 }\r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 void vApplicationIdleHook( void )\r
 203 {\r
 204 const unsigned long ulMSToSleep = 5;\r
 205 \r
 206         /* If the file system is only going to be accessed from one task then\r
 207         F_FS_THREAD_AWARE can be set to 0 and the set of example files is created\r
 208         before the RTOS scheduler is started.  If the file system is going to be\r
 209         access from more than one task then F_FS_THREAD_AWARE must be set to 1 and\r
 210         the     set of sample files are created from the idle task hook function. */\r
 211         #if F_FS_THREAD_AWARE == 1\r
 212         {\r
 213                 static BaseType_t xCreatedSampleFiles = pdFALSE;\r
 214 \r
 215                 /* Initialise the drive and file system, then create a few example\r
 216                 files.  The output from this function just goes to the stdout window,\r
 217                 allowing the output to be viewed when the UDP command console is not\r
 218                 connected. */\r
 219                 if( xCreatedSampleFiles == pdFALSE )\r
 220                 {\r
 221                         vCreateAndVerifySampleFiles();\r
 222                         xCreatedSampleFiles = pdTRUE;\r
 223                 }\r
 224         }\r
 225         #endif\r
 226 \r
 227         /* This function is called on each cycle of the idle task if\r
 228         configUSE_IDLE_HOOK is set to 1 in FreeRTOSConfig.h.  Sleep to reduce CPU\r
 229         load. */\r
 230         Sleep( ulMSToSleep );\r
 231 }\r
 232 /*-----------------------------------------------------------*/\r
 233 \r
 234 void vAssertCalled( const char *pcFile, unsigned long ulLine )\r
 235 {\r
 236         printf( "ASSERT FAILED: File %s, line %u\r\n", pcFile, ulLine );\r
 237 }\r
 238 /*-----------------------------------------------------------*/\r
 239 \r
 240 void vApplicationMallocFailedHook( void )\r
 241 {\r
 242         /* vApplicationMallocFailedHook() will only be called if\r
 243         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
 244         function that will get called if a call to pvPortMalloc() fails.\r
 245         pvPortMalloc() is called internally by the kernel whenever a task, queue,\r
 246         timer or semaphore is created.  It is also called by various parts of the\r
 247         demo application.  If heap_1.c, heap_2.c or heap_4.c are used, then the\r
 248         size of the heap available to pvPortMalloc() is defined by\r
 249         configTOTAL_HEAP_SIZE in FreeRTOSConfig.h, and the xPortGetFreeHeapSize()\r
 250         API function can be used to query the size of free heap space that remains\r
 251         (although it does not provide information on how the remaining heap might\r
 252         be fragmented). */\r
 253         taskDISABLE_INTERRUPTS();\r
 254         for( ;; );\r
 255 }\r
 256 \r
 257 \r
 258 \r