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
97 /* FreeRTOS includes. */
\r
98 #include "FreeRTOS.h"
\r
101 /* Standard includes. */
\r
102 #include <stdint.h>
\r
104 #include <stdlib.h>
\r
105 #include <string.h>
\r
107 /* FreeRTOS+CLI includes. */
\r
108 #include "FreeRTOS_CLI.h"
\r
110 /* File system includes. */
\r
111 #include "fat_sl.h"
\r
112 #include "api_mdriver_ram.h"
\r
115 #define snprintf _snprintf
\r
118 #define cliNEW_LINE "\r\n"
\r
120 /*******************************************************************************
\r
121 * See the URL in the comments within main.c for the location of the online
\r
123 ******************************************************************************/
\r
126 * Print out information on a single file.
\r
128 static void prvCreateFileInfoString( char *pcBuffer, F_FIND *pxFindStruct );
\r
131 * Copies an existing file into a newly created file.
\r
133 static BaseType_t prvPerformCopy( const char *pcSourceFile,
\r
134 int32_t lSourceFileLength,
\r
135 const char *pcDestinationFile,
\r
136 char *pxWriteBuffer,
\r
137 size_t xWriteBufferLen );
\r
140 * Implements the DIR command.
\r
142 static BaseType_t prvDIRCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
145 * Implements the CD command.
\r
147 static BaseType_t prvCDCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
150 * Implements the DEL command.
\r
152 static BaseType_t prvDELCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
155 * Implements the TYPE command.
\r
157 static BaseType_t prvTYPECommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
160 * Implements the COPY command.
\r
162 static BaseType_t prvCOPYCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString );
\r
164 /* Structure that defines the DIR command line command, which lists all the
\r
165 files in the current directory. */
\r
166 static const CLI_Command_Definition_t xDIR =
\r
168 "dir", /* The command string to type. */
\r
169 "\r\ndir:\r\n Lists the files in the current directory\r\n",
\r
170 prvDIRCommand, /* The function to run. */
\r
171 0 /* No parameters are expected. */
\r
174 /* Structure that defines the CD command line command, which changes the
\r
175 working directory. */
\r
176 static const CLI_Command_Definition_t xCD =
\r
178 "cd", /* The command string to type. */
\r
179 "\r\ncd <dir name>:\r\n Changes the working directory\r\n",
\r
180 prvCDCommand, /* The function to run. */
\r
181 1 /* One parameter is expected. */
\r
184 /* Structure that defines the TYPE command line command, which prints the
\r
185 contents of a file to the console. */
\r
186 static const CLI_Command_Definition_t xTYPE =
\r
188 "type", /* The command string to type. */
\r
189 "\r\ntype <filename>:\r\n Prints file contents to the terminal\r\n",
\r
190 prvTYPECommand, /* The function to run. */
\r
191 1 /* One parameter is expected. */
\r
194 /* Structure that defines the DEL command line command, which deletes a file. */
\r
195 static const CLI_Command_Definition_t xDEL =
\r
197 "del", /* The command string to type. */
\r
198 "\r\ndel <filename>:\r\n deletes a file or directory\r\n",
\r
199 prvDELCommand, /* The function to run. */
\r
200 1 /* One parameter is expected. */
\r
203 /* Structure that defines the COPY command line command, which deletes a file. */
\r
204 static const CLI_Command_Definition_t xCOPY =
\r
206 "copy", /* The command string to type. */
\r
207 "\r\ncopy <source file> <dest file>:\r\n Copies <source file> to <dest file>\r\n",
\r
208 prvCOPYCommand, /* The function to run. */
\r
209 2 /* Two parameters are expected. */
\r
213 /*-----------------------------------------------------------*/
\r
215 void vRegisterFileSystemCLICommands( void )
\r
217 /* Register all the command line commands defined immediately above. */
\r
218 FreeRTOS_CLIRegisterCommand( &xDIR );
\r
219 FreeRTOS_CLIRegisterCommand( &xCD );
\r
220 FreeRTOS_CLIRegisterCommand( &xTYPE );
\r
221 FreeRTOS_CLIRegisterCommand( &xDEL );
\r
222 FreeRTOS_CLIRegisterCommand( &xCOPY );
\r
224 /*-----------------------------------------------------------*/
\r
226 static BaseType_t prvTYPECommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
228 const char *pcParameter;
\r
229 BaseType_t xParameterStringLength, xReturn = pdTRUE;
\r
230 static F_FILE *pxFile = NULL;
\r
233 size_t xColumns = 50U;
\r
235 /* Ensure there is always a null terminator after each character written. */
\r
236 memset( pcWriteBuffer, 0x00, xWriteBufferLen );
\r
238 /* Ensure the buffer leaves space for the \r\n. */
\r
239 configASSERT( xWriteBufferLen > ( strlen( cliNEW_LINE ) * 2 ) );
\r
240 xWriteBufferLen -= strlen( cliNEW_LINE );
\r
242 if( xWriteBufferLen < xColumns )
\r
244 /* Ensure the loop that uses xColumns as an end condition does not
\r
245 write off the end of the buffer. */
\r
246 xColumns = xWriteBufferLen;
\r
249 if( pxFile == NULL )
\r
251 /* The file has not been opened yet. Find the file name. */
\r
252 pcParameter = FreeRTOS_CLIGetParameter
\r
254 pcCommandString, /* The command string itself. */
\r
255 1, /* Return the first parameter. */
\r
256 &xParameterStringLength /* Store the parameter string length. */
\r
259 /* Sanity check something was returned. */
\r
260 configASSERT( pcParameter );
\r
262 /* Attempt to open the requested file. */
\r
263 pxFile = f_open( pcParameter, "r" );
\r
266 if( pxFile != NULL )
\r
268 /* Read the next chunk of data from the file. */
\r
269 for( xByte = 0; xByte < xColumns; xByte++ )
\r
271 iChar = f_getc( pxFile );
\r
275 /* No more characters to return. */
\r
282 pcWriteBuffer[ xByte ] = ( char ) iChar;
\r
287 if( pxFile == NULL )
\r
289 /* Either the file was not opened, or all the data from the file has
\r
290 been returned and the file is now closed. */
\r
294 strcat( pcWriteBuffer, cliNEW_LINE );
\r
298 /*-----------------------------------------------------------*/
\r
300 static BaseType_t prvCDCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
302 const char *pcParameter;
\r
303 BaseType_t xParameterStringLength;
\r
304 unsigned char ucReturned;
\r
305 size_t xStringLength;
\r
307 /* Obtain the parameter string. */
\r
308 pcParameter = FreeRTOS_CLIGetParameter
\r
310 pcCommandString, /* The command string itself. */
\r
311 1, /* Return the first parameter. */
\r
312 &xParameterStringLength /* Store the parameter string length. */
\r
315 /* Sanity check something was returned. */
\r
316 configASSERT( pcParameter );
\r
318 /* Attempt to move to the requested directory. */
\r
319 ucReturned = f_chdir( pcParameter );
\r
321 if( ucReturned == F_NO_ERROR )
\r
323 sprintf( pcWriteBuffer, "In: " );
\r
324 xStringLength = strlen( pcWriteBuffer );
\r
325 f_getcwd( &( pcWriteBuffer[ xStringLength ] ), ( unsigned char ) ( xWriteBufferLen - xStringLength ) );
\r
329 sprintf( pcWriteBuffer, "Error" );
\r
332 strcat( pcWriteBuffer, cliNEW_LINE );
\r
336 /*-----------------------------------------------------------*/
\r
338 static BaseType_t prvDIRCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
340 static F_FIND *pxFindStruct = NULL;
\r
341 unsigned char ucReturned;
\r
342 BaseType_t xReturn = pdFALSE;
\r
344 /* This assumes pcWriteBuffer is long enough. */
\r
345 ( void ) pcCommandString;
\r
347 /* Ensure the buffer leaves space for the \r\n. */
\r
348 configASSERT( xWriteBufferLen > ( strlen( cliNEW_LINE ) * 2 ) );
\r
349 xWriteBufferLen -= strlen( cliNEW_LINE );
\r
351 if( pxFindStruct == NULL )
\r
353 /* This is the first time this function has been executed since the Dir
\r
354 command was run. Create the find structure. */
\r
355 pxFindStruct = ( F_FIND * ) pvPortMalloc( sizeof( F_FIND ) );
\r
357 if( pxFindStruct != NULL )
\r
359 ucReturned = f_findfirst( "*.*", pxFindStruct );
\r
361 if( ucReturned == F_NO_ERROR )
\r
363 prvCreateFileInfoString( pcWriteBuffer, pxFindStruct );
\r
368 snprintf( pcWriteBuffer, xWriteBufferLen, "Error: f_findfirst() failed." );
\r
373 snprintf( pcWriteBuffer, xWriteBufferLen, "Failed to allocate RAM (using heap_4.c will prevent fragmentation)." );
\r
378 /* The find struct has already been created. Find the next file in
\r
380 ucReturned = f_findnext( pxFindStruct );
\r
382 if( ucReturned == F_NO_ERROR )
\r
384 prvCreateFileInfoString( pcWriteBuffer, pxFindStruct );
\r
389 /* There are no more files. Free the find structure. */
\r
390 vPortFree( pxFindStruct );
\r
391 pxFindStruct = NULL;
\r
393 /* No string to return. */
\r
394 pcWriteBuffer[ 0 ] = 0x00;
\r
398 strcat( pcWriteBuffer, cliNEW_LINE );
\r
402 /*-----------------------------------------------------------*/
\r
404 static BaseType_t prvDELCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
406 const char *pcParameter;
\r
407 BaseType_t xParameterStringLength;
\r
408 unsigned char ucReturned;
\r
410 /* This function assumes xWriteBufferLen is large enough! */
\r
411 ( void ) xWriteBufferLen;
\r
413 /* Obtain the parameter string. */
\r
414 pcParameter = FreeRTOS_CLIGetParameter
\r
416 pcCommandString, /* The command string itself. */
\r
417 1, /* Return the first parameter. */
\r
418 &xParameterStringLength /* Store the parameter string length. */
\r
421 /* Sanity check something was returned. */
\r
422 configASSERT( pcParameter );
\r
424 /* Attempt to delete the file. */
\r
425 ucReturned = f_delete( pcParameter );
\r
427 if( ucReturned == F_NO_ERROR )
\r
429 sprintf( pcWriteBuffer, "%s was deleted", pcParameter );
\r
433 sprintf( pcWriteBuffer, "Error" );
\r
436 strcat( pcWriteBuffer, cliNEW_LINE );
\r
440 /*-----------------------------------------------------------*/
\r
442 static BaseType_t prvCOPYCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString )
\r
444 char *pcSourceFile, *pcDestinationFile;
\r
445 BaseType_t xParameterStringLength;
\r
446 long lSourceLength, lDestinationLength = 0;
\r
448 /* Obtain the name of the destination file. */
\r
449 pcDestinationFile = ( char * ) FreeRTOS_CLIGetParameter
\r
451 pcCommandString, /* The command string itself. */
\r
452 2, /* Return the second parameter. */
\r
453 &xParameterStringLength /* Store the parameter string length. */
\r
456 /* Sanity check something was returned. */
\r
457 configASSERT( pcDestinationFile );
\r
459 /* Obtain the name of the source file. */
\r
460 pcSourceFile = ( char * ) FreeRTOS_CLIGetParameter
\r
462 pcCommandString, /* The command string itself. */
\r
463 1, /* Return the first parameter. */
\r
464 &xParameterStringLength /* Store the parameter string length. */
\r
467 /* Sanity check something was returned. */
\r
468 configASSERT( pcSourceFile );
\r
470 /* Terminate the string. */
\r
471 pcSourceFile[ xParameterStringLength ] = 0x00;
\r
473 /* See if the source file exists, obtain its length if it does. */
\r
474 lSourceLength = f_filelength( pcSourceFile );
\r
476 if( lSourceLength == 0 )
\r
478 sprintf( pcWriteBuffer, "Source file does not exist" );
\r
482 /* See if the destination file exists. */
\r
483 lDestinationLength = f_filelength( pcDestinationFile );
\r
485 if( lDestinationLength != 0 )
\r
487 sprintf( pcWriteBuffer, "Error: Destination file already exists" );
\r
491 /* Continue only if the source file exists and the destination file does
\r
493 if( ( lSourceLength != 0 ) && ( lDestinationLength == 0 ) )
\r
495 if( prvPerformCopy( pcSourceFile, lSourceLength, pcDestinationFile, pcWriteBuffer, xWriteBufferLen ) == pdPASS )
\r
497 sprintf( pcWriteBuffer, "Copy made" );
\r
501 sprintf( pcWriteBuffer, "Error during copy" );
\r
505 strcat( pcWriteBuffer, cliNEW_LINE );
\r
509 /*-----------------------------------------------------------*/
\r
511 static BaseType_t prvPerformCopy( const char *pcSourceFile,
\r
512 int32_t lSourceFileLength,
\r
513 const char *pcDestinationFile,
\r
514 char *pxWriteBuffer,
\r
515 size_t xWriteBufferLen )
\r
517 int32_t lBytesRead = 0, lBytesToRead, lBytesRemaining;
\r
519 BaseType_t xReturn = pdPASS;
\r
521 /* NOTE: Error handling has been omitted for clarity. */
\r
523 while( lBytesRead < lSourceFileLength )
\r
525 /* How many bytes are left? */
\r
526 lBytesRemaining = lSourceFileLength - lBytesRead;
\r
528 /* How many bytes should be read this time around the loop. Can't
\r
529 read more bytes than will fit into the buffer. */
\r
530 if( lBytesRemaining > ( long ) xWriteBufferLen )
\r
532 lBytesToRead = ( long ) xWriteBufferLen;
\r
536 lBytesToRead = lBytesRemaining;
\r
539 /* Open the source file, seek past the data that has already been
\r
540 read from the file, read the next block of data, then close the
\r
541 file again so the destination file can be opened. */
\r
542 pxFile = f_open( pcSourceFile, "r" );
\r
543 if( pxFile != NULL )
\r
545 f_seek( pxFile, lBytesRead, F_SEEK_SET );
\r
546 f_read( pxWriteBuffer, lBytesToRead, 1, pxFile );
\r
555 /* Open the destination file and write the block of data to the end of
\r
557 pxFile = f_open( pcDestinationFile, "a" );
\r
558 if( pxFile != NULL )
\r
560 f_write( pxWriteBuffer, lBytesToRead, 1, pxFile );
\r
569 lBytesRead += lBytesToRead;
\r
574 /*-----------------------------------------------------------*/
\r
576 static void prvCreateFileInfoString( char *pcBuffer, F_FIND *pxFindStruct )
\r
578 const char *pcWritableFile = "writable file", *pcReadOnlyFile = "read only file", *pcDirectory = "directory";
\r
579 const char * pcAttrib;
\r
581 /* Point pcAttrib to a string that describes the file. */
\r
582 if( ( pxFindStruct->attr & F_ATTR_DIR ) != 0 )
\r
584 pcAttrib = pcDirectory;
\r
586 else if( pxFindStruct->attr & F_ATTR_READONLY )
\r
588 pcAttrib = pcReadOnlyFile;
\r
592 pcAttrib = pcWritableFile;
\r
595 /* Create a string that includes the file name, the file size and the
\r
596 attributes string. */
\r
597 sprintf( pcBuffer, "%s [%s] [size=%d]", pxFindStruct->filename, pcAttrib, ( int ) pxFindStruct->filesize );
\r