git.sur5r.net Git - freertos/blob - FreeRTOS-Plus/Demo/FreeRTOS_Plus_FAT_SL_and_CLI_Windows_Simulator/File-system-demo.c

   1 /*\r
   2     FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not itcan be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  67     Integrity Systems, who sell the code with commercial support,\r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69 \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  71     engineered and independently SIL3 certified version for use in safety and\r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*******************************************************************************\r
  76  * See the URL in the comments within main.c for the location of the online\r
  77  * documentation.\r
  78  ******************************************************************************/\r
  79 \r
  80 /* Standard includes. */\r
  81 #include <stdio.h>\r
  82 \r
  83 /* FreeRTOS includes. */\r
  84 #include "FreeRTOS.h"\r
  85 \r
  86 /* File system includes. */\r
  87 #include "fat_sl.h"\r
  88 #include "api_mdriver_ram.h"\r
  89 \r
  90 /* 8.3 format, plus null terminator. */\r
  91 #define fsMAX_FILE_NAME_LEN                             13\r
  92 \r
  93 /* The number of bytes read/written to the example files at a time. */\r
  94 #define fsRAM_BUFFER_SIZE                               200\r
  95 \r
  96 /* The number of bytes written to the file that uses f_putc() and f_getc(). */\r
  97 #define fsPUTC_FILE_SIZE                                100\r
  98 \r
  99 /*-----------------------------------------------------------*/\r
 100 \r
 101 /*\r
 102  * Creates and verifies different files on the volume, demonstrating the use of\r
 103  * various different API functions.\r
 104  */\r
 105 void vCreateAndVerifySampleFiles( void );\r
 106 \r
 107 /*\r
 108  * Create a set of example files in the root directory of the volume using\r
 109  * f_write().\r
 110  */\r
 111 static void prvCreateDemoFilesUsing_f_write( void );\r
 112 \r
 113 /*\r
 114  * Use f_read() to read back and verify the files that were created by\r
 115  * prvCreateDemoFilesUsing_f_write().\r
 116  */\r
 117 static void prvVerifyDemoFileUsing_f_read( void );\r
 118 \r
 119 /*\r
 120  * Create an example file in a sub-directory using f_putc().\r
 121  */\r
 122 static void prvCreateDemoFileUsing_f_putc( void );\r
 123 \r
 124 /*\r
 125  * Use f_getc() to read back and verify the file that was created by\r
 126  * prvCreateDemoFileUsing_f_putc().\r
 127  */\r
 128 static void prvVerifyDemoFileUsing_f_getc( void );\r
 129 \r
 130 /*-----------------------------------------------------------*/\r
 131 \r
 132 /* A buffer used to both create content to write to disk, and read content back\r
 133 from a disk.  Note there is no mutual exclusion on this buffer. */\r
 134 static char cRAMBuffer[ fsRAM_BUFFER_SIZE ];\r
 135 \r
 136 /* Names of directories that are created. */\r
 137 static const char *pcRoot = "/", *pcDirectory1 = "SUB1", *pcDirectory2 = "SUB2", *pcFullPath = "/SUB1/SUB2";\r
 138 \r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 void vCreateAndVerifySampleFiles( void )\r
 142 {\r
 143 unsigned char ucStatus;\r
 144 \r
 145         /* First create the volume. */\r
 146         ucStatus = f_initvolume( ram_initfunc );\r
 147 \r
 148         /* It is expected that the volume is not formatted. */\r
 149         if( ucStatus == F_ERR_NOTFORMATTED )\r
 150         {\r
 151                 /* Format the created volume. */\r
 152                 ucStatus = f_format( F_FAT12_MEDIA );\r
 153         }\r
 154 \r
 155         if( ucStatus == F_NO_ERROR )\r
 156         {\r
 157                 /* Create a set of files using f_write(). */\r
 158                 prvCreateDemoFilesUsing_f_write();\r
 159 \r
 160                 /* Read back and verify the files that were created using f_write(). */\r
 161                 prvVerifyDemoFileUsing_f_read();\r
 162 \r
 163                 /* Create sub directories two deep then create a file using putc. */\r
 164                 prvCreateDemoFileUsing_f_putc();\r
 165 \r
 166                 /* Read back and verify the file created by\r
 167                 prvCreateDemoFileUsing_f_putc(). */\r
 168                 prvVerifyDemoFileUsing_f_getc();\r
 169         }\r
 170 }\r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 static void prvCreateDemoFilesUsing_f_write( void )\r
 174 {\r
 175 portBASE_TYPE xFileNumber, xWriteNumber;\r
 176 char cFileName[ fsMAX_FILE_NAME_LEN ];\r
 177 const portBASE_TYPE xMaxFiles = 5;\r
 178 long lItemsWritten;\r
 179 F_FILE *pxFile;\r
 180 \r
 181         /* Create xMaxFiles files.  Each created file will be\r
 182         ( xFileNumber * fsRAM_BUFFER_SIZE ) bytes in length, and filled\r
 183         with a different repeating character. */\r
 184         for( xFileNumber = 1; xFileNumber <= xMaxFiles; xFileNumber++ )\r
 185         {\r
 186                 /* Generate a file name. */\r
 187                 sprintf( cFileName, "root%03d.txt", xFileNumber );\r
 188 \r
 189                 /* Obtain the current working directory and print out the file name and\r
 190                 the     directory into which the file is being written. */\r
 191                 f_getcwd( cRAMBuffer, fsRAM_BUFFER_SIZE );\r
 192                 printf( "Creating file %s in %s\r\n", cFileName, cRAMBuffer );\r
 193 \r
 194                 /* Open the file, creating the file if it does not already exist. */\r
 195                 pxFile = f_open( cFileName, "w" );\r
 196                 configASSERT( pxFile );\r
 197 \r
 198                 /* Fill the RAM buffer with data that will be written to the file.  This\r
 199                 is just a repeating ascii character that indicates the file number. */\r
 200                 memset( cRAMBuffer, ( int ) ( '0' + xFileNumber ), fsRAM_BUFFER_SIZE );\r
 201 \r
 202                 /* Write the RAM buffer to the opened file a number of times.  The\r
 203                 number of times the RAM buffer is written to the file depends on the\r
 204                 file number, so the length of each created file will be different. */\r
 205                 for( xWriteNumber = 0; xWriteNumber < xFileNumber; xWriteNumber++ )\r
 206                 {\r
 207                         lItemsWritten = f_write( cRAMBuffer, fsRAM_BUFFER_SIZE, 1, pxFile );\r
 208                         configASSERT( lItemsWritten == 1 );\r
 209                 }\r
 210 \r
 211                 /* Close the file so another file can be created. */\r
 212                 f_close( pxFile );\r
 213         }\r
 214 }\r
 215 /*-----------------------------------------------------------*/\r
 216 \r
 217 static void prvVerifyDemoFileUsing_f_read( void )\r
 218 {\r
 219 portBASE_TYPE xFileNumber, xReadNumber;\r
 220 char cFileName[ fsMAX_FILE_NAME_LEN ];\r
 221 const portBASE_TYPE xMaxFiles = 5;\r
 222 long lItemsRead, lChar;\r
 223 F_FILE *pxFile;\r
 224 \r
 225         /* Read back the files that were created by\r
 226         prvCreateDemoFilesUsing_f_write(). */\r
 227         for( xFileNumber = 1; xFileNumber <= xMaxFiles; xFileNumber++ )\r
 228         {\r
 229                 /* Generate the file name. */\r
 230                 sprintf( cFileName, "root%03d.txt", xFileNumber );\r
 231 \r
 232                 /* Obtain the current working directory and print out the file name and\r
 233                 the     directory from which the file is being read. */\r
 234                 f_getcwd( cRAMBuffer, fsRAM_BUFFER_SIZE );\r
 235                 printf( "Reading file %s from %s\r\n", cFileName, cRAMBuffer );\r
 236 \r
 237                 /* Open the file for reading. */\r
 238                 pxFile = f_open( cFileName, "r" );\r
 239                 configASSERT( pxFile );\r
 240 \r
 241                 /* Read the file into the RAM buffer, checking the file contents are as\r
 242                 expected.  The size of the file depends on the file number. */\r
 243                 for( xReadNumber = 0; xReadNumber < xFileNumber; xReadNumber++ )\r
 244                 {\r
 245                         /* Start with the RAM buffer clear. */\r
 246                         memset( cRAMBuffer, 0x00, fsRAM_BUFFER_SIZE );\r
 247 \r
 248                         lItemsRead = f_read( cRAMBuffer, fsRAM_BUFFER_SIZE, 1, pxFile );\r
 249                         configASSERT( lItemsRead == 1 );\r
 250 \r
 251                         /* Check the RAM buffer is filled with the expected data.  Each\r
 252                         file contains a different repeating ascii character that indicates\r
 253                         the number of the file. */\r
 254                         for( lChar = 0; lChar < fsRAM_BUFFER_SIZE; lChar++ )\r
 255                         {\r
 256                                 configASSERT( cRAMBuffer[ lChar ] == ( '0' + ( char ) xFileNumber ) );\r
 257                         }\r
 258                 }\r
 259 \r
 260                 /* Close the file. */\r
 261                 f_close( pxFile );\r
 262         }\r
 263 }\r
 264 /*-----------------------------------------------------------*/\r
 265 \r
 266 static void prvCreateDemoFileUsing_f_putc( void )\r
 267 {\r
 268 unsigned char ucReturn;\r
 269 int iByte, iReturned;\r
 270 F_FILE *pxFile;\r
 271 char cFileName[ fsMAX_FILE_NAME_LEN ];\r
 272 \r
 273         /* Obtain and print out the working directory. */\r
 274         f_getcwd( cRAMBuffer, fsRAM_BUFFER_SIZE );\r
 275         printf( "In directory %s\r\n", cRAMBuffer );\r
 276 \r
 277         /* Create a sub directory. */\r
 278         ucReturn = f_mkdir( pcDirectory1 );\r
 279         configASSERT( ucReturn == F_NO_ERROR );\r
 280 \r
 281         /* Move into the created sub-directory. */\r
 282         ucReturn = f_chdir( pcDirectory1 );\r
 283         configASSERT( ucReturn == F_NO_ERROR );\r
 284 \r
 285         /* Obtain and print out the working directory. */\r
 286         f_getcwd( cRAMBuffer, fsRAM_BUFFER_SIZE );\r
 287         printf( "In directory %s\r\n", cRAMBuffer );\r
 288 \r
 289         /* Create a subdirectory in the new directory. */\r
 290         ucReturn = f_mkdir( pcDirectory2 );\r
 291         configASSERT( ucReturn == F_NO_ERROR );\r
 292 \r
 293         /* Move into the directory just created - now two directories down from\r
 294         the root. */\r
 295         ucReturn = f_chdir( pcDirectory2 );\r
 296         configASSERT( ucReturn == F_NO_ERROR );\r
 297 \r
 298         /* Obtain and print out the working directory. */\r
 299         f_getcwd( cRAMBuffer, fsRAM_BUFFER_SIZE );\r
 300         printf( "In directory %s\r\n", cRAMBuffer );\r
 301         configASSERT( strcmp( ( const char * ) cRAMBuffer, pcFullPath ) == 0 );\r
 302 \r
 303         /* Generate the file name. */\r
 304         sprintf( cFileName, "%s.txt", pcDirectory2 );\r
 305 \r
 306         /* Print out the file name and the directory into which the file is being\r
 307         written. */\r
 308         printf( "Writing file %s in %s\r\n", cFileName, cRAMBuffer );\r
 309 \r
 310         pxFile = f_open( cFileName, "w" );\r
 311 \r
 312         /* Create a file 1 byte at a time.  The file is filled with incrementing\r
 313         ascii characters starting from '0'. */\r
 314         for( iByte = 0; iByte < fsPUTC_FILE_SIZE; iByte++ )\r
 315         {\r
 316                 iReturned = f_putc( ( ( int ) '0' + iByte ), pxFile );\r
 317                 configASSERT( iReturned ==  ( ( int ) '0' + iByte ) );\r
 318         }\r
 319 \r
 320         /* Finished so close the file. */\r
 321         f_close( pxFile );\r
 322 \r
 323         /* Move back to the root directory. */\r
 324         ucReturn = f_chdir( "../.." );\r
 325         configASSERT( ucReturn == F_NO_ERROR );\r
 326 \r
 327         /* Obtain and print out the working directory. */\r
 328         f_getcwd( cRAMBuffer, fsRAM_BUFFER_SIZE );\r
 329         printf( "Back in root directory %s\r\n", cRAMBuffer );\r
 330         configASSERT( strcmp( ( const char * ) cRAMBuffer, pcRoot ) == 0 );\r
 331 }\r
 332 /*-----------------------------------------------------------*/\r
 333 \r
 334 static void prvVerifyDemoFileUsing_f_getc( void )\r
 335 {\r
 336 unsigned char ucReturn;\r
 337 int iByte, iReturned;\r
 338 F_FILE *pxFile;\r
 339 char cFileName[ fsMAX_FILE_NAME_LEN ];\r
 340 \r
 341         /* Move into the directory in which the file was created. */\r
 342         ucReturn = f_chdir( pcFullPath );\r
 343         configASSERT( ucReturn == F_NO_ERROR );\r
 344 \r
 345         /* Obtain and print out the working directory. */\r
 346         f_getcwd( cRAMBuffer, fsRAM_BUFFER_SIZE );\r
 347         printf( "Back in directory %s\r\n", cRAMBuffer );\r
 348         configASSERT( strcmp( ( const char * ) cRAMBuffer, pcFullPath ) == 0 );\r
 349 \r
 350         /* Generate the file name. */\r
 351         sprintf( cFileName, "%s.txt", pcDirectory2 );\r
 352 \r
 353         /* Print out the file name and the directory from which the file is being\r
 354         read. */\r
 355         printf( "Reading file %s in %s\r\n", cFileName, cRAMBuffer );\r
 356 \r
 357         /* This time the file is opened for reading. */\r
 358         pxFile = f_open( cFileName, "r" );\r
 359 \r
 360         /* Read the file 1 byte at a time. */\r
 361         for( iByte = 0; iByte < fsPUTC_FILE_SIZE; iByte++ )\r
 362         {\r
 363                 iReturned = f_getc( pxFile );\r
 364                 configASSERT( iReturned ==  ( ( int ) '0' + iByte ) );\r
 365         }\r
 366 \r
 367         /* Finished so close the file. */\r
 368         f_close( pxFile );\r
 369 \r
 370         /* Move back to the root directory. */\r
 371         ucReturn = f_chdir( "../.." );\r
 372         configASSERT( ucReturn == F_NO_ERROR );\r
 373 \r
 374         /* Obtain and print out the working directory. */\r
 375         f_getcwd( cRAMBuffer, fsRAM_BUFFER_SIZE );\r
 376         printf( "Back in root directory %s\r\n", cRAMBuffer );\r
 377 }\r
 378 \r
 379 \r
 380 \r
 381 \r