2 FreeRTOS V8.2.0rc1 - Copyright (C) 2014 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\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
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
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
25 ***************************************************************************
\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
30 * http://www.FreeRTOS.org/FAQHelp.html *
\r
32 ***************************************************************************
\r
34 ***************************************************************************
\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
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
46 ***************************************************************************
\r
48 ***************************************************************************
\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
62 ***************************************************************************
\r
64 ***************************************************************************
\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
73 ***************************************************************************
\r
75 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
76 license and Real Time Engineers Ltd. contact details.
\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
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
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
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
96 /* FreeRTOS includes. */
\r
97 #include "FreeRTOS.h"
\r
100 /* Standard includes. */
\r
101 #include <stdint.h>
\r
103 #include <stdlib.h>
\r
104 #include <string.h>
\r
106 /* FreeRTOS+CLI includes. */
\r
107 #include "FreeRTOS_CLI.h"
\r
109 /* File system includes. */
\r
110 #include "fat_sl.h"
\r
111 #include "api_mdriver_ram.h"
\r
114 #define snprintf _snprintf
\r
117 #define cliNEW_LINE "\r\n"
\r
119 /*******************************************************************************
\r
120 * See the URL in the comments within main.c for the location of the online
\r
122 ******************************************************************************/
\r
125 * Print out information on a single file.
\r
127 static void prvCreateFileInfoString( char *pcBuffer, F_FIND *pxFindStruct );
\r
130 * Copies an existing file into a newly created file.
\r
132 static portBASE_TYPE prvPerformCopy( const char *pcSourceFile,
\r
133 int32_t lSourceFileLength,
\r
134 const char *pcDestinationFile,
\r
135 char *pxWriteBuffer,
\r
136 size_t xWriteBufferLen );
\r
139 * Implements the DIR command.
\r
141 static portBASE_TYPE prvDIRCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
144 * Implements the CD command.
\r
146 static portBASE_TYPE prvCDCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
149 * Implements the DEL command.
\r
151 static portBASE_TYPE prvDELCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
154 * Implements the TYPE command.
\r
156 static portBASE_TYPE prvTYPECommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
159 * Implements the COPY command.
\r
161 static portBASE_TYPE prvCOPYCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
163 /* Structure that defines the DIR command line command, which lists all the
\r
164 files in the current directory. */
\r
165 static const CLI_Command_Definition_t xDIR =
\r
167 "dir", /* The command string to type. */
\r
168 "\r\ndir:\r\n Lists the files in the current directory\r\n",
\r
169 prvDIRCommand, /* The function to run. */
\r
170 0 /* No parameters are expected. */
\r
173 /* Structure that defines the CD command line command, which changes the
\r
174 working directory. */
\r
175 static const CLI_Command_Definition_t xCD =
\r
177 "cd", /* The command string to type. */
\r
178 "\r\ncd <dir name>:\r\n Changes the working directory\r\n",
\r
179 prvCDCommand, /* The function to run. */
\r
180 1 /* One parameter is expected. */
\r
183 /* Structure that defines the TYPE command line command, which prints the
\r
184 contents of a file to the console. */
\r
185 static const CLI_Command_Definition_t xTYPE =
\r
187 "type", /* The command string to type. */
\r
188 "\r\ntype <filename>:\r\n Prints file contents to the terminal\r\n",
\r
189 prvTYPECommand, /* The function to run. */
\r
190 1 /* One parameter is expected. */
\r
193 /* Structure that defines the DEL command line command, which deletes a file. */
\r
194 static const CLI_Command_Definition_t xDEL =
\r
196 "del", /* The command string to type. */
\r
197 "\r\ndel <filename>:\r\n deletes a file or directory\r\n",
\r
198 prvDELCommand, /* The function to run. */
\r
199 1 /* One parameter is expected. */
\r
202 /* Structure that defines the COPY command line command, which deletes a file. */
\r
203 static const CLI_Command_Definition_t xCOPY =
\r
205 "copy", /* The command string to type. */
\r
206 "\r\ncopy <source file> <dest file>:\r\n Copies <source file> to <dest file>\r\n",
\r
207 prvCOPYCommand, /* The function to run. */
\r
208 2 /* Two parameters are expected. */
\r
211 /*-----------------------------------------------------------*/
\r
213 void vRegisterFileSystemCLICommands( void )
\r
215 /* Register all the command line commands defined immediately above. */
\r
216 FreeRTOS_CLIRegisterCommand( &xDIR );
\r
217 FreeRTOS_CLIRegisterCommand( &xCD );
\r
218 FreeRTOS_CLIRegisterCommand( &xTYPE );
\r
219 FreeRTOS_CLIRegisterCommand( &xDEL );
\r
220 FreeRTOS_CLIRegisterCommand( &xCOPY );
\r
222 /*-----------------------------------------------------------*/
\r
224 static portBASE_TYPE prvTYPECommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
226 const char *pcParameter;
\r
227 portBASE_TYPE xParameterStringLength, xReturn = pdTRUE;
\r
228 static F_FILE *pxFile = NULL;
\r
231 size_t xColumns = 50U;
\r
233 /* Ensure there is always a null terminator after each character written. */
\r
234 memset( pcWriteBuffer, 0x00, xWriteBufferLen );
\r
236 /* Ensure the buffer leaves space for the \r\n. */
\r
237 configASSERT( xWriteBufferLen > ( strlen( cliNEW_LINE ) * 2 ) );
\r
238 xWriteBufferLen -= strlen( cliNEW_LINE );
\r
240 if( xWriteBufferLen < xColumns )
\r
242 /* Ensure the loop that uses xColumns as an end condition does not
\r
243 write off the end of the buffer. */
\r
244 xColumns = xWriteBufferLen;
\r
247 if( pxFile == NULL )
\r
249 /* The file has not been opened yet. Find the file name. */
\r
250 pcParameter = FreeRTOS_CLIGetParameter
\r
252 pcCommandString, /* The command string itself. */
\r
253 1, /* Return the first parameter. */
\r
254 &xParameterStringLength /* Store the parameter string length. */
\r
257 /* Sanity check something was returned. */
\r
258 configASSERT( pcParameter );
\r
260 /* Attempt to open the requested file. */
\r
261 pxFile = f_open( pcParameter, "r" );
\r
264 if( pxFile != NULL )
\r
266 /* Read the next chunk of data from the file. */
\r
267 for( xByte = 0; xByte < xColumns; xByte++ )
\r
269 iChar = f_getc( pxFile );
\r
273 /* No more characters to return. */
\r
280 pcWriteBuffer[ xByte ] = ( char ) iChar;
\r
285 if( pxFile == NULL )
\r
287 /* Either the file was not opened, or all the data from the file has
\r
288 been returned and the file is now closed. */
\r
292 strcat( pcWriteBuffer, cliNEW_LINE );
\r
296 /*-----------------------------------------------------------*/
\r
298 static portBASE_TYPE prvCDCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
300 const char *pcParameter;
\r
301 portBASE_TYPE xParameterStringLength;
\r
302 unsigned char ucReturned;
\r
303 size_t xStringLength;
\r
305 /* Obtain the parameter string. */
\r
306 pcParameter = FreeRTOS_CLIGetParameter
\r
308 pcCommandString, /* The command string itself. */
\r
309 1, /* Return the first parameter. */
\r
310 &xParameterStringLength /* Store the parameter string length. */
\r
313 /* Sanity check something was returned. */
\r
314 configASSERT( pcParameter );
\r
316 /* Attempt to move to the requested directory. */
\r
317 ucReturned = f_chdir( pcParameter );
\r
319 if( ucReturned == F_NO_ERROR )
\r
321 sprintf( pcWriteBuffer, "In: " );
\r
322 xStringLength = strlen( pcWriteBuffer );
\r
323 f_getcwd( &( pcWriteBuffer[ xStringLength ] ), ( unsigned char ) ( xWriteBufferLen - xStringLength ) );
\r
327 sprintf( pcWriteBuffer, "Error" );
\r
330 strcat( pcWriteBuffer, cliNEW_LINE );
\r
334 /*-----------------------------------------------------------*/
\r
336 static portBASE_TYPE prvDIRCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
338 static F_FIND *pxFindStruct = NULL;
\r
339 unsigned char ucReturned;
\r
340 portBASE_TYPE xReturn = pdFALSE;
\r
342 /* This assumes pcWriteBuffer is long enough. */
\r
343 ( void ) pcCommandString;
\r
345 /* Ensure the buffer leaves space for the \r\n. */
\r
346 configASSERT( xWriteBufferLen > ( strlen( cliNEW_LINE ) * 2 ) );
\r
347 xWriteBufferLen -= strlen( cliNEW_LINE );
\r
349 if( pxFindStruct == NULL )
\r
351 /* This is the first time this function has been executed since the Dir
\r
352 command was run. Create the find structure. */
\r
353 pxFindStruct = ( F_FIND * ) pvPortMalloc( sizeof( F_FIND ) );
\r
355 if( pxFindStruct != NULL )
\r
357 ucReturned = f_findfirst( "*.*", pxFindStruct );
\r
359 if( ucReturned == F_NO_ERROR )
\r
361 prvCreateFileInfoString( pcWriteBuffer, pxFindStruct );
\r
366 snprintf( pcWriteBuffer, xWriteBufferLen, "Error: f_findfirst() failed." );
\r
371 snprintf( pcWriteBuffer, xWriteBufferLen, "Failed to allocate RAM (using heap_4.c will prevent fragmentation)." );
\r
376 /* The find struct has already been created. Find the next file in
\r
378 ucReturned = f_findnext( pxFindStruct );
\r
380 if( ucReturned == F_NO_ERROR )
\r
382 prvCreateFileInfoString( pcWriteBuffer, pxFindStruct );
\r
387 /* There are no more files. Free the find structure. */
\r
388 vPortFree( pxFindStruct );
\r
389 pxFindStruct = NULL;
\r
391 /* No string to return. */
\r
392 pcWriteBuffer[ 0 ] = 0x00;
\r
396 strcat( pcWriteBuffer, cliNEW_LINE );
\r
400 /*-----------------------------------------------------------*/
\r
402 static portBASE_TYPE prvDELCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
404 const char *pcParameter;
\r
405 portBASE_TYPE xParameterStringLength;
\r
406 unsigned char ucReturned;
\r
408 /* This function assumes xWriteBufferLen is large enough! */
\r
409 ( void ) xWriteBufferLen;
\r
411 /* Obtain the parameter string. */
\r
412 pcParameter = FreeRTOS_CLIGetParameter
\r
414 pcCommandString, /* The command string itself. */
\r
415 1, /* Return the first parameter. */
\r
416 &xParameterStringLength /* Store the parameter string length. */
\r
419 /* Sanity check something was returned. */
\r
420 configASSERT( pcParameter );
\r
422 /* Attempt to delete the file. */
\r
423 ucReturned = f_delete( pcParameter );
\r
425 if( ucReturned == F_NO_ERROR )
\r
427 sprintf( pcWriteBuffer, "%s was deleted", pcParameter );
\r
431 sprintf( pcWriteBuffer, "Error" );
\r
434 strcat( pcWriteBuffer, cliNEW_LINE );
\r
438 /*-----------------------------------------------------------*/
\r
440 static portBASE_TYPE prvCOPYCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
442 const char *pcDestinationFile;
\r
443 char *pcSourceFile;
\r
444 portBASE_TYPE xParameterStringLength;
\r
445 long lSourceLength, lDestinationLength = 0;
\r
447 /* Obtain the name of the destination file. */
\r
448 pcDestinationFile = FreeRTOS_CLIGetParameter
\r
450 pcCommandString, /* The command string itself. */
\r
451 2, /* Return the second parameter. */
\r
452 &xParameterStringLength /* Store the parameter string length. */
\r
455 /* Sanity check something was returned. */
\r
456 configASSERT( pcDestinationFile );
\r
458 /* Obtain the name of the source file. */
\r
459 pcSourceFile = ( char * ) FreeRTOS_CLIGetParameter
\r
461 pcCommandString, /* The command string itself. */
\r
462 1, /* Return the first parameter. */
\r
463 &xParameterStringLength /* Store the parameter string length. */
\r
466 /* Sanity check something was returned. */
\r
467 configASSERT( pcSourceFile );
\r
469 /* Terminate the string. */
\r
470 pcSourceFile[ xParameterStringLength ] = 0x00;
\r
472 /* See if the source file exists, obtain its length if it does. */
\r
473 lSourceLength = f_filelength( pcSourceFile );
\r
475 if( lSourceLength == 0 )
\r
477 sprintf( pcWriteBuffer, "Source file does not exist" );
\r
481 /* See if the destination file exists. */
\r
482 lDestinationLength = f_filelength( pcDestinationFile );
\r
484 if( lDestinationLength != 0 )
\r
486 sprintf( pcWriteBuffer, "Error: Destination file already exists" );
\r
490 /* Continue only if the source file exists and the destination file does
\r
492 if( ( lSourceLength != 0 ) && ( lDestinationLength == 0 ) )
\r
494 if( prvPerformCopy( pcSourceFile, lSourceLength, pcDestinationFile, pcWriteBuffer, xWriteBufferLen ) == pdPASS )
\r
496 sprintf( pcWriteBuffer, "Copy made" );
\r
500 sprintf( pcWriteBuffer, "Error during copy" );
\r
504 strcat( pcWriteBuffer, cliNEW_LINE );
\r
508 /*-----------------------------------------------------------*/
\r
510 static portBASE_TYPE prvPerformCopy( const char *pcSourceFile,
\r
511 int32_t lSourceFileLength,
\r
512 const char *pcDestinationFile,
\r
513 char *pxWriteBuffer,
\r
514 size_t xWriteBufferLen )
\r
516 int32_t lBytesRead = 0, lBytesToRead, lBytesRemaining;
\r
518 portBASE_TYPE xReturn = pdPASS;
\r
520 /* NOTE: Error handling has been omitted for clarity. */
\r
522 while( lBytesRead < lSourceFileLength )
\r
524 /* How many bytes are left? */
\r
525 lBytesRemaining = lSourceFileLength - lBytesRead;
\r
527 /* How many bytes should be read this time around the loop. Can't
\r
528 read more bytes than will fit into the buffer. */
\r
529 if( lBytesRemaining > ( long ) xWriteBufferLen )
\r
531 lBytesToRead = ( long ) xWriteBufferLen;
\r
535 lBytesToRead = lBytesRemaining;
\r
538 /* Open the source file, seek past the data that has already been
\r
539 read from the file, read the next block of data, then close the
\r
540 file again so the destination file can be opened. */
\r
541 pxFile = f_open( pcSourceFile, "r" );
\r
542 if( pxFile != NULL )
\r
544 f_seek( pxFile, lBytesRead, F_SEEK_SET );
\r
545 f_read( pxWriteBuffer, lBytesToRead, 1, pxFile );
\r
554 /* Open the destination file and write the block of data to the end of
\r
556 pxFile = f_open( pcDestinationFile, "a" );
\r
557 if( pxFile != NULL )
\r
559 f_write( pxWriteBuffer, lBytesToRead, 1, pxFile );
\r
568 lBytesRead += lBytesToRead;
\r
573 /*-----------------------------------------------------------*/
\r
575 static void prvCreateFileInfoString( char *pcBuffer, F_FIND *pxFindStruct )
\r
577 const char *pcWritableFile = "writable file", *pcReadOnlyFile = "read only file", *pcDirectory = "directory";
\r
578 const char * pcAttrib;
\r
580 /* Point pcAttrib to a string that describes the file. */
\r
581 if( ( pxFindStruct->attr & F_ATTR_DIR ) != 0 )
\r
583 pcAttrib = pcDirectory;
\r
585 else if( pxFindStruct->attr & F_ATTR_READONLY )
\r
587 pcAttrib = pcReadOnlyFile;
\r
591 pcAttrib = pcWritableFile;
\r
594 /* Create a string that includes the file name, the file size and the
\r
595 attributes string. */
\r
596 sprintf( pcBuffer, "%s [%s] [size=%d]", pxFindStruct->filename, pcAttrib, ( int ) pxFindStruct->filesize );
\r