Page Comparison

...

Anchor10915371091537 Using the Shell Commands Anchor10953791095379To use shell commands, four files, in addition to the generic file system files, must be included in the build:anchor10953801095380

fs_shell.c

...

fs_shell.h

...

shell.c (located in \Micrium\Software\uC-Shell\Source)

...

shell.h (located in \Micrium\Software\uC-Shell\Source)

...

10915431091543The file fs_shell.h and shell.h must also be #included in any application or header files initialize µC/Shell or handle shell commands. The shell command configuration file (fs_shell_cfg.h) should be copied to your application directory and modified. The following directories must be on the project include path:anchor10915441091544

\Micrium\Software\uC-FS\Cmd

...

\Micrium\Software\uC-Shell\Source

...

µC/Shell with the µC/FS shell commands is initialized in Listing F-1"Initializing µC/Shell". The file system initialization (FS_Init()) function should have previously been called.anchor

Code Block

...

language

...

1092253

HTML Table

summary

class

Code_Listing

Table Row (tr)

Table Cell (td)

Anchor

1092253

cpp

...

{


{
    CPU_BOOLEAN  ok;

ok =


    ok = Shell_Init();

if


    if (ok == DEF_FAIL)

{ return

 {
        return (DEF_FAIL);

} ok =


    }
    
    ok = FSShell_Init();

if


    if (ok == DEF_FAIL)

{ return

 {
        return (DEF_FAIL;

} return


    }
    return (DEF_OK);

}

title	Initializing µC/Shell

CPU_BOOLEAN  App_ShellInit (void)

Anchor

1092254

Anchor

1092255

Anchor

1092256

Anchor

1092257

Anchor

1092258

Anchor

1092259

Anchor

1092260

Anchor

1092261

Anchor

1092262

Anchor

1092263

Anchor

1092264

Anchor

1092265

Anchor

1092266

...

It’s assumed that the application will create a task to receive input from a terminal; this task should be written as shown in Listing F-2"Executing shell commands & handling shell output".anchor

Code Block

...

language

...

void

HTML Table

summary

class

Code_Listing

Table Row (tr)

Table Cell (td)

Anchor

1092283

cpp

...

{ CPU_CHAR


{
    CPU_CHAR          cmd_line[MAX_CMD_LEN];


    SHELL_ERR

err;

         err;
    SHELL_CMD_PARAM   cmd_param;


    CPU_CHAR          cwd_path[FS_CFG_FULL_ NAME_LEN +

1u]; /* Init cmd param (see Note #1). */

 1u];
 
                                                  (1)
    Str_Copy(&cwd_path[0], (CPU_CHAR *)"\\");


    cmd_param.pcur_working_dir = (void *)cwd_path[0];


    cmd_param.pout_opt         = (void *)0;

while


 
    while (DEF_TRUE)

{

 {
        App_ShellIn(cmd_line, MAX_CMD_LEN);

/* Rd cmd (see Note #2). */ /* Exec cmd (see Note #3). */

       (2)
                                                  (3)
        Shell_Exec(cmd_line, App_ShellOut, &cmd_param, &err);

switch


        switch (err)

{ case

 {
            case SHELL_ERR_CMD_NOT_FOUND:

case


            case SHELL_ERR_CMD_SEARCH:

case


            case SHELL_ERR_ARG_TBL_FULL:


                 App_ShellOut("Command not found\r\n", 19, cmd_param.pout_opt);

break; default: break; } } } /*


                 break;
            default:
                 break;
        }    
    }
}
 
/*
**************************************************************************************

*


*                                    App_ShellIn()


*******************************************************************************

1

*******

*/


CPU_INT16S  App_ShellIn (CPU_CHAR

*pbuf, CPU_INT16U buf_len) { /* $$$$ Store line from terminal/command line into ‘pbuf’; return length of line. */ } /*

    *pbuf,       
                         CPU_INT16U   buf_len)
{
    /* $$$$ Store line from terminal/command line into 'pbuf'; return length of line. */
}
/*
**************************************************************************************

*


*                                    App_ShellOut()


*******************************************************************************

1

*******

*/


CPU_INT16S  App_ShellOut (CPU_CHAR

*pbuf, CPU_INT16U buf_len, void *popt) { /* $$$$ Output ‘pbuf’ data on terminal/command line; return nbr bytes tx’d. */ }

title	Executing shell commands & handling shell output

void  App_ShellTask (void *p_arg)

Anchor

1092284

Anchor

1092285

Anchor

1092286

Anchor

1092287

Anchor

1092288

Anchor

1092405

Anchor

1092289

Anchor

1092290

Anchor

1092291

Anchor

1092292

Anchor

1092293

Anchor

1092412

Anchor

1092294

Anchor

1092295

Anchor

1092296

Anchor

1092297

Anchor

1092298

Anchor

1092299

Anchor

1092300

Anchor

1092301

Anchor

1092302

Anchor

1092303

Anchor

1092304

Anchor

1092305

Anchor

1092306

Anchor

1092307

Anchor

1092359

Anchor

1092308

Anchor

1092309

Anchor

1092310

Anchor

1092311

Anchor

1092312

Anchor

1092313

Anchor

1092314

Anchor

1092315

Anchor

1092316

Anchor

1092317

Table Row (tr)

Table Cell (td)

Anchor

1092425

Anchor

1092383

Anchor

1092384

Anchor

1092385

Anchor

1092386

Anchor

1092387

Anchor

1092388

Anchor

1092389

Anchor

1092390

Anchor

1092391

Anchor

1092392

...

    *pbuf,
                          CPU_INT16U   buf_len,
                          void        *popt)
{
    /* $$$$ Output 'pbuf' data on terminal/command line;  return nbr bytes tx'd. */
}

Panel

bgColor	#f0f0f0

(1) The SHELL_CMD_PARAM structure that will be passed to Shell_Exec() must be initialized. The pcur_working_dir member must be assigned a pointer to a string of at

...

least FS_SHELL_CFG_MAX_PATH_LEN

...

characters. This string must have been initialized to the default working directory path; if the root directory, “\”.

...

(2) The next command, ending with a newline, should be read from the command line.

...

(3) The received command should be executed

...

with Shell_Exec(). If the command is a valid command, the appropriate command function will be called. For example, the command

...

“fs_

...

ls” will result

...

in FSShell_ls()

...

in fs_shell.c

...

being called. FSShell_ls()

...

will then print the entries in the working directory to the command line with the output

...

function App_ShellOut(), passed as the second argument

...

of Shell_Exec().

Versions Compared

Old Version 1

New Version Current

Key