PikeAero::CTaskConsole Class Reference

#include <ctaskconsole.h>

Inheritance diagram for PikeAero::CTaskConsole:

[legend]

Collaboration diagram for PikeAero::CTaskConsole:

[legend]

Public Member Functions
	CTaskConsole (CCommunication *comm)
virtual void	event (CEvent *e)
virtual CMachine::bit32	fault ()
	The CTaskScheduler will call the fault() method when a fault code was returned by any of the task's other methods.
virtual CMachine::bit32	init ()
	called exactly once. perform task initialization such as initializing private variable. other tasks are not guaranteed so do not interract with other tasks at this stage.
virtual const char *	name ()
virtual CMachine::bit32	run ()
	called periodically by CTaskScheduler to do a piece of work.
virtual CMachine::bit32	start ()
	called exactly once. all tasks are initialized at this point. called just prior to first call to run()
virtual CMachine::bit32	stop ()
	The CTaskScheduler will call the stop () method after the task was scheduled for cancelation.
virtual	~CTaskConsole ()
Protected Member Functions
CMachine::bit32	commandDump (CArray< CString * > *argv)
CMachine::bit32	commandFlash (CArray< CString * > *argv)
CMachine::bit32	commandHelp (CArray< CString * > *argv)
CMachine::bit32	commandPeek (CArray< CString * > *argv)
CMachine::bit32	commandPoke (CArray< CString * > *argv)
CMachine::bit32	commandReset (CArray< CString * > *argv)
CMachine::bit32	commandTop (CArray< CString * > *argv)
void	drawCommandPrompt ()
	Draw the command prompt.
void	drawStatusBar ()
	Draw status bar.
CMachine::bit32	execute (CString *command)
	Execute a command.
virtual void	monitor ()

---

Detailed Description

The console object.

Author:

Michael Sharkey <mike@pikeaero.com>

Definition at line 34 of file ctaskconsole.h.

---

Constructor & Destructor Documentation

PikeAero::CTaskConsole::CTaskConsole

(

CCommunication *

comm

)

Definition at line 31 of file ctaskconsole.cpp.

 : inherited(comm)
{
}

PikeAero::CTaskConsole::~CTaskConsole

(

)

[virtual]

Definition at line 37 of file ctaskconsole.cpp.

{
}

---

Member Function Documentation

CMachine::bit32 PikeAero::CTaskConsole::commandDump

(

CArray< CString * > *

argv

)

[protected]

Definition at line 285 of file ctaskconsole.cpp.

References PikeAero::CArray< T >::at(), and PikeAero::CArray< T >::count().

Referenced by execute().

{
    CString addr = (argv->count() > 2) ? *(argv->at(1)) : "";
    CString size = (argv->count() > 2) ? *(argv->at(2)) : "";
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::commandFlash

(

CArray< CString * > *

argv

)

[protected]

Definition at line 299 of file ctaskconsole.cpp.

Referenced by execute().

{
    return 0;
}

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::commandHelp

(

CArray< CString * > *

argv

)

[protected]

Definition at line 304 of file ctaskconsole.cpp.

References PikeAero::CArray< T >::at(), PikeAero::CTaskTerminal::comm(), PikeAero::CArray< T >::count(), and PikeAero::CCommunication::tx().

Referenced by execute(), and run().

{
    CString arg = (argv != NULL && argv->count() > 1) ? *(argv->at(1)) : "";

    comm()->tx( "--------------- help ---------------\r\n" );
    comm()->tx( "\r\n" );

    if ( arg == "" || arg == "top" )
    {
        comm()->tx( "top\r\n" );
        if ( arg == "top" )
        {
            comm()->tx( "\r\n" );
            comm()->tx( "Continuously monitor tasks\r\n" );
            comm()->tx( "and A/D inputs.\r\n" );
            comm()->tx( "\r\n" );
            comm()->tx( "Updates display once per second.\r\n" );
        }
    }

    if ( arg == "" || arg == "peek" )
    {
        comm()->tx( "peek        <address>\r\n" );
    }

    if ( arg == "" || arg == "poke" )
    {
        comm()->tx( "poke        <address> <data> <byte|short|word>\r\n" );
    }

    if ( arg == "" || arg == "dump" )
    {
        comm()->tx( "dump        <address> <size> <byte|short|word>\r\n" );
    }

    if ( arg == "" || arg == "reset" )
    {
        comm()->tx( "reset\r\n" );
    }

    if ( arg == "" || arg == "flash" )
    {
        comm()->tx( "flash\r\n" );
    }

    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::commandPeek

(

CArray< CString * > *

argv

)

[protected]

Definition at line 275 of file ctaskconsole.cpp.

Referenced by execute().

{
    return 0;
}

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::commandPoke

(

CArray< CString * > *

argv

)

[protected]

Definition at line 280 of file ctaskconsole.cpp.

Referenced by execute().

{
    return 0;
}

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::commandReset

(

CArray< CString * > *

argv

)

[protected]

Definition at line 292 of file ctaskconsole.cpp.

References PRCCU, PRCCU_HALT, and PRCCU_SRESEN.

Referenced by execute().

{
    PRCCU->CCR |= PRCCU_SRESEN;
    PRCCU->SMR |= PRCCU_HALT;
    return 0;
}

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::commandTop

(

CArray< CString * > *

argv

)

[protected]

Definition at line 268 of file ctaskconsole.cpp.

References PikeAero::CTaskTerminal::eraseDisplay(), PikeAero::CTaskConsoleBase::mMonitorMode, and PikeAero::CTaskConsoleBase::monitorStats.

Referenced by execute().

{
    mMonitorMode = monitorStats;
    eraseDisplay();
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CTaskConsole::drawCommandPrompt

(

)

[protected]

Draw the command prompt.

Definition at line 142 of file ctaskconsole.cpp.

References PikeAero::CTaskTerminal::comm(), PikeAero::CByteArray::data(), PikeAero::CTaskTerminal::eraseLine(), PikeAero::CTaskConsoleBase::mCommandLine, PikeAero::CString::sprintf(), and PikeAero::CCommunication::tx().

Referenced by run().

{
    CString str;
    comm()->tx("\r");
    str.sprintf( "STINGRAY III > %s", mCommandLine.data() );
    comm()->tx(str);
    eraseLine();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CTaskConsole::drawStatusBar

(

)

[protected]

Draw status bar.

Definition at line 154 of file ctaskconsole.cpp.

References PikeAero::CTaskTerminal::comm(), PikeAero::CTaskTerminal::cursorMoveAbsolute(), PikeAero::CTaskTerminal::eraseLine(), PikeAero::CTaskConsoleBase::mAggregator, PikeAero::CTaskAggregator::rpm(), PikeAero::CString::sprintf(), and PikeAero::CCommunication::tx().

Referenced by monitor().

{
    CString str;
    cursorMoveAbsolute(0,24);
    str.sprintf( "RPM: %5d", mAggregator->rpm() );
    comm()->tx(str);
    eraseLine();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CTaskConsole::event

(

CEvent *

e

)

[virtual]

Returns:

Receive a software event.

receive a software event [ inherits pointer ownership ]

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 409 of file ctaskconsole.cpp.

References PikeAero::CEvent::Clock, PikeAero::CTaskConsoleBase::mMonitorMode, PikeAero::CTaskConsoleBase::monitorNone, PikeAero::CTaskConsoleBase::mRunMonitor, and PikeAero::CEvent::type().

{
    if ( e->type() == CEvent::Clock )
    {
        if ( mMonitorMode != monitorNone  )
        {
            mRunMonitor=true;
        }
    }
    inherited::event(e);
}

Here is the call graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::execute

(

CString *

command

)

[protected]

Execute a command.

determine what the command is and take action...

Delete the argument string objects...

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 355 of file ctaskconsole.cpp.

References PikeAero::CArray< T >::at(), commandDump(), commandFlash(), commandHelp(), commandPeek(), commandPoke(), commandReset(), commandTop(), PikeAero::CArray< T >::count(), and PikeAero::CString::explode().

Referenced by run().

{
    CMachine::bit32 rc = 1;
    CArray<CString*> argv = command->explode(' ');

    if ( argv.count() )
    {
        /**
        ** determine what the command is and take action...
        */
        if ( *(argv.at(0)) == "help" )
        {
            rc = commandHelp(&argv);
        }
        else if ( *(argv.at(0)) == "top" )
        {
            rc = commandTop(&argv);
        }
        else if ( *(argv.at(0)) == "peek" )
        {
            rc = commandPeek(&argv);
        }
        else if ( *(argv.at(0)) == "poke" )
        {
            rc = commandPoke(&argv);
        }
        else if ( *(argv.at(0)) == "dump" )
        {
            rc = commandDump(&argv);
        }
        else if ( *(argv.at(0)) == "reset" )
        {
            rc = commandReset(&argv);
        }
        else if ( *(argv.at(0)) == "flash" )
        {
            rc = commandFlash(&argv);
        }

        /**
        ** Delete the argument string objects...
        */
        for ( CMachine::ubit32 i = 0; i < argv.count(); i++ )
        {
            CString* str = argv.at(i);
            delete str;
        }
    }
    return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::fault

(

)

[virtual]

The CTaskScheduler will call the fault() method when a fault code was returned by any of the task's other methods.

Returns:

0 on success.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 134 of file ctaskconsole.cpp.

References stop().

{
    return inherited::stop();
}

Here is the call graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::init

(

)

[virtual]

called exactly once. perform task initialization such as initializing private variable. other tasks are not guaranteed so do not interract with other tasks at this stage.

Returns:

0 on success.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 46 of file ctaskconsole.cpp.

{
    return inherited::init();
}

void PikeAero::CTaskConsole::monitor

(

)

[protected, virtual]

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 163 of file ctaskconsole.cpp.

References PikeAero::CTaskAggregator::analog(), PikeAero::CTaskScheduler::at(), PikeAero::CMemHeap::available(), PikeAero::CMemHeap::bottom(), PikeAero::CByteArray::clear(), PikeAero::CTaskTerminal::clearAttributes(), PikeAero::CTaskTerminal::comm(), PikeAero::CTaskScheduler::count(), PikeAero::CTaskTerminal::cursorMoveAbsolute(), PikeAero::CTaskAggregator::days(), PikeAero::CTaskAggregator::deliverEventsPerSecond(), PikeAero::CTaskAggregator::dequeueEventsPerSecond(), drawStatusBar(), PikeAero::CTaskAggregator::enqueueEventsPerSecond(), PikeAero::CTaskTerminal::eraseLine(), PikeAero::CMachine::firmwareVersion(), PikeAero::CMachine::fMCLK(), PikeAero::ITask::getFault(), PikeAero::CTaskAggregator::hours(), PikeAero::CTaskConsoleBase::mAggregator, PikeAero::CTaskAggregator::maxEventsInQueuePerSecond(), PikeAero::CTaskAggregator::minutes(), PikeAero::CTaskConsoleBase::mRunMonitor, PikeAero::ITask::name(), PikeAero::ITask::priority(), PikeAero::ITask::running(), PikeAero::CTaskAggregator::seconds(), PikeAero::CTaskTerminal::setAttributeReverseVideo(), PikeAero::ITask::sleeping(), PikeAero::ITask::slicesPerSecond(), PikeAero::CString::sprintf(), stackPointer, stackTop, stackUsed, PikeAero::CTaskScheduler::tasksEventDriven(), PikeAero::CTaskAggregator::taskSlicesPerSecond(), PikeAero::CTaskScheduler::tasksRunning(), PikeAero::CTaskScheduler::tasksSleeping(), PikeAero::CMemHeap::top(), PikeAero::CCommunication::tx(), PikeAero::CMemHeap::used(), PikeAero::CTaskAggregator::vectorIRQCountPerSecond(), and PikeAero::ITask::yielding().

Referenced by run().

{
    if ( mAggregator != NULL && mRunMonitor )
    {
        CString str;
        CMachine::ubit32 taskCount = CTaskScheduler::count();
        CMachine::ubit32 top = stackTop();
        CMachine::ubit32 ptr = stackPointer();
        CMachine::ubit32 used = stackUsed();

        mRunMonitor=false;

        cursorMoveAbsolute(0,2);
        str.clear();
        str.sprintf( "STINGRAY III V%s | STR730FZ2 @ %02dMHz | %02d:%02d:%02d:%02d                                     ",
            CMachine::firmwareVersion(),
            CMachine::fMCLK() > 1000000 ? CMachine::fMCLK()/1000000 : CMachine::fMCLK(),
            mAggregator->days(), mAggregator->hours(), mAggregator->minutes(), mAggregator->seconds() );
        setAttributeReverseVideo();
        comm()->tx( str );
        clearAttributes();
        eraseLine();

        cursorMoveAbsolute(0,3);
        str.clear();
        str.sprintf( "Tasks:   %3d total, %3d running, %3d sleeping, %3d stopped" ,
                        taskCount,
                        CTaskScheduler::tasksRunning(),
                        CTaskScheduler::tasksSleeping(),
                        CTaskScheduler::tasksEventDriven() );
        comm()->tx( str );
        eraseLine();

        cursorMoveAbsolute(0,4);
        str.clear();
        str.sprintf( "Slices: %5d slices/sec, %3d uSec/slice, %5d irq/sec" ,
                        mAggregator->taskSlicesPerSecond(),
                        1000000/mAggregator->taskSlicesPerSecond(),
                        mAggregator->vectorIRQCountPerSecond() );
        comm()->tx( str );
        eraseLine();

        cursorMoveAbsolute(0,5);
        str.clear();
        str.sprintf( "Event: %5d enqueue/sec, %5d dequeue/sec, %5d deliver/sec, %3d maxq/sec" ,
                        mAggregator->enqueueEventsPerSecond(),
                        mAggregator->dequeueEventsPerSecond(),
                        mAggregator->deliverEventsPerSecond(),
                        mAggregator->maxEventsInQueuePerSecond() );
        comm()->tx( str );
        eraseLine();

        cursorMoveAbsolute(0,6);
        str.clear();
        str.sprintf( "Stack: %5d total, %5d used, %5d free",
                        top-(CMachine::ubit32)CMemHeap::top(),
                        used,
                        (top-(CMachine::ubit32)CMemHeap::top())-used );
        comm()->tx( str );
        eraseLine();

        cursorMoveAbsolute(0,7);
        str.clear();
        str.sprintf( "Heap:  %5d total, %5d used, %5d free",
                        CMemHeap::top()-CMemHeap::bottom(),
                        CMemHeap::used(),
                        CMemHeap::available() );
        comm()->tx( str );
        eraseLine();

        cursorMoveAbsolute(0,8);
        for( CMachine::ubit32 i=0; i < 16; i++ )
        {
            str.clear();
            str.sprintf( "%5d", mAggregator->analog(i));
            comm()->tx(str);
        }

        cursorMoveAbsolute(0,9);
        setAttributeReverseVideo();
        comm()->tx( "  PID PR ST ADDRESS  FAULT %CPU NAME                                                    " );
        clearAttributes();
        eraseLine();

        for( CMachine::ubit32 n=0; n < taskCount; n++ )
        {
            ITask* task = CTaskScheduler::at(n);
            cursorMoveAbsolute(0,10+n);
            str.clear();
            str.sprintf( "%5d %2d %s %08x %5d %4d %s",
                        n,
                        (CMachine::ubit32)task->priority(),
                        task->sleeping() ? " s" : task->yielding() ? "-r" : task->running() ? " R" : " r",
                        (CMachine::ubit32)task,
                        task->getFault(),
                        (task->slicesPerSecond()*100)/mAggregator->taskSlicesPerSecond(),
                        task->name() );
            comm()->tx( str );
            eraseLine();
        }

        drawStatusBar();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const char* PikeAero::CTaskConsole::name

(

)

[inline, virtual]

Returns:

a CString containing an human readable name for the task

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 43 of file ctaskconsole.h.

{return "CTaskConsole";}

CMachine::bit32 PikeAero::CTaskConsole::run

(

)

[virtual]

called periodically by CTaskScheduler to do a piece of work.

run in terminal mode

Returns:

0 on success.

interpret input here

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 72 of file ctaskconsole.cpp.

References PikeAero::CString::append(), PikeAero::CByteArray::clear(), PikeAero::CTaskTerminal::comm(), commandHelp(), drawCommandPrompt(), execute(), PikeAero::CString::length(), PikeAero::CTaskConsoleBase::mCommandLine, PikeAero::CTaskConsoleBase::mFirstTime, PikeAero::CTaskConsoleBase::mMonitorMode, monitor(), PikeAero::CTaskConsoleBase::monitorNone, PikeAero::CString::resize(), PikeAero::CCommunication::rx(), and PikeAero::CCommunication::tx().

{
    if ( mFirstTime )
    {
        mFirstTime=false;
        comm()->tx("\r\nSTINGRAY III\r\n");
        comm()->tx("Copyright (c) 2005-2009 Pike Aerospace Research Corporation\r\n");
        comm()->tx("http://www.pikeaero.com\r\n");
        comm()->tx("info@pikeaero.com\r\n");
        comm()->tx("\r\n");

        drawCommandPrompt();
    }

    monitor();

    /** interpret input here  */
    while ( comm()->rxReady() )
    {
        CMachine::ubit8 ch = comm()->rx();
        mMonitorMode = monitorNone;
        switch ( ch )
        {
            case '\n':
            case '\r':
                comm()->tx("\r\n");
                if ( execute( &mCommandLine ) == 0 )
                {
                    comm()->tx("\r\n");
                    mCommandLine.clear();
                }
                else
                {
                    commandHelp( NULL );
                }
                drawCommandPrompt();
            break;
            case '\b':
            case 0x7F:
                if ( mCommandLine.length() > 0 )
                {
                    mCommandLine.resize(mCommandLine.length()-1);
                    comm()->tx("\b \b");
                }
                break;
            default:
                if ( ch >= ' ' && ch <= '~' )
                {
                    mCommandLine.append(ch);
                    comm()->tx(ch);
                }
                break;
        }
    }

    return inherited::run();
}

Here is the call graph for this function:

CMachine::bit32 PikeAero::CTaskConsole::start

(

)

[virtual]

called exactly once. all tasks are initialized at this point. called just prior to first call to run()

Returns:

0 on success.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 55 of file ctaskconsole.cpp.

{
    return inherited::start();
}

CMachine::bit32 PikeAero::CTaskConsole::stop

(

)

[virtual]

The CTaskScheduler will call the stop () method after the task was scheduled for cancelation.

Returns:

0 on success.

Reimplemented from PikeAero::CTaskConsoleBase.

Definition at line 64 of file ctaskconsole.cpp.

Referenced by fault().

{
    return inherited::stop();
}

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• ctaskconsole.h
• ctaskconsole.cpp