PikeAero::CTaskAnalogInputADC Class Reference

#include <ctaskanaloginputadc.h>

Inheritance diagram for PikeAero::CTaskAnalogInputADC:

[legend]

Collaboration diagram for PikeAero::CTaskAnalogInputADC:

[legend]

Public Member Functions
	CTaskAnalogInputADC ()
virtual void	event (CEvent *e)
	recieve events that wake up bottom half.
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 void	irq (CMachine::InterruptVector v)
	receive a hardware interrupt
virtual const char *	name ()
	returns a CString containing an human readable name for the task
virtual CMachine::bit32	run ()
	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 CMachine::bit32	start ()
	initialize the class.
virtual CMachine::bit32	stop ()
	The CTaskScheduler will call the stop () method after the task was scheduled for cancelation.
CMachine::ubit32	value (CMachine::ubit32 y)
	Fetch the value last latched from an analog channel.
virtual	~CTaskAnalogInputADC ()
Protected Member Functions
void	calibrate ()
	Start a calibration cycle. WARNING: does not yield CPU time!

---

Detailed Description

Implements the Analog to Digital (ADC) reader.

Author:

Michael Sharkey <mike@pikeaero.com>

Definition at line 33 of file ctaskanaloginputadc.h.

---

Constructor & Destructor Documentation

PikeAero::CTaskAnalogInputADC::CTaskAnalogInputADC

(

)

Disable ADC Interrupts

Reset Control Registers

Power up the ADC

Enable auto clock off

Set the conversion and sampling prescaler configuration (fADC = fMCLK/14) = 2.28MHz

Set the conversion scan mode - continuous scan all channels

Enable Interrupts on End of Chain (all 16 channels converted)

Install self into interupt vector

This is an event driven task, should get no run time unless an event occures

Definition at line 26 of file ctaskanaloginputadc.cpp.

References ADC, ADC_ACKO, ADC_CNVP, ADC_FCH, ADC_IT_ECH, ADC_NCH, ADC_PWDN, ADC_SMPP, ADC_SPEN, PikeAero::CMachine::installVectorIRQ(), PikeAero::ITask::PriorityLow, PikeAero::ITask::setPriority(), and PikeAero::CMachine::Vector_ADC.

: ITask()
{
    /** Disable ADC Interrupts */
    ADC->IMR = 0;

    /** Reset Control Registers */
    ADC->CLR0 = 0;
    ADC->CLR1 = 0;
    ADC->CLR2 = 0;
    ADC->CLR3 = 0;
    ADC->CLR4 = 0;

    /** Power up the ADC */
    ADC->CLR4 &= ~ADC_PWDN;
    /** Enable auto clock off */
    ADC->CLR4 |= ADC_ACKO;
    /** Set the conversion and sampling prescaler configuration  (fADC = fMCLK/14) = 2.28MHz */
    ADC->CLR1 = ( ADC_SPEN | ADC_CNVP(0x07) | ADC_SMPP(0x07) );
    /** Set the conversion scan mode - continuous scan all channels */
    ADC->CLR2 = ( ADC_NCH(0x0F) | ADC_FCH(0x00) );
    /** Enable Interrupts on End of Chain (all 16 channels converted) */
    ADC->IMR = ( ADC_IT_ECH );

    /** Install self into interupt vector */
    CMachine::installVectorIRQ(CMachine::Vector_ADC,this);

    /** This is an event driven task, should get no run time unless an event occures */
    setPriority( ITask::PriorityLow );
}

Here is the call graph for this function:

PikeAero::CTaskAnalogInputADC::~CTaskAnalogInputADC

(

)

[virtual]

stop the A/D conversion chain

Remove self from interrupt vector

Definition at line 58 of file ctaskanaloginputadc.cpp.

References ADC, ADC_START, PikeAero::CEventQueue::removeListener(), PikeAero::CMachine::removeVectorIRQ(), and PikeAero::CEvent::Tick.

{
    CEventQueue::removeListener(this,CEvent::Tick);
    /** stop the A/D conversion chain */
    ADC->CLR0 &= ~ADC_START;
    /** Remove self from interrupt vector */
    CMachine::removeVectorIRQ(this);
}

Here is the call graph for this function:

---

Member Function Documentation

void PikeAero::CTaskAnalogInputADC::calibrate

(

)

[protected]

Start a calibration cycle. WARNING: does not yield CPU time!

Definition at line 81 of file ctaskanaloginputadc.cpp.

References ADC, ADC_CAL, and PikeAero::CMachine::resetWatchDog().

Referenced by start().

{
    ADC->CLR0 = ADC_CAL;
    for ( CMachine::ubit32 timeout = 1000000; timeout && (ADC->CLR0 & ADC_CAL); timeout-- )
    {
        CMachine::resetWatchDog();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CTaskAnalogInputADC::event

(

CEvent *

e

)

[virtual]

recieve events that wake up bottom half.

receive a software event

Reimplemented from PikeAero::CObject.

Definition at line 148 of file ctaskanaloginputadc.cpp.

References PikeAero::ITask::setSleeping(), PikeAero::CEvent::Tick, and PikeAero::CEvent::type().

Referenced by run().

{
    switch( e->type() )
    {
        case CEvent::Tick: /* 1/10 second */
            {
                setSleeping(false);
            }
            break;
        default:
            break;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

CMachine::bit32 PikeAero::CTaskAnalogInputADC::fault

(

)

[virtual]

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

Reimplemented from PikeAero::ITask.

Definition at line 140 of file ctaskanaloginputadc.cpp.

References PikeAero::CObject::errOK.

{
    return errOK;
}

void PikeAero::CTaskAnalogInputADC::irq

(

CMachine::InterruptVector

v

)

[virtual]

receive a hardware interrupt

receive a hardware interrupt [ top half ]

Clear the End of Chain (all 16 channels converted) interrupt pending flags

stop the A/D conversion chain

clear the End Of Chain pending bit

wake up the bottom half

Reimplemented from PikeAero::CObject.

Definition at line 165 of file ctaskanaloginputadc.cpp.

References ADC, ADC_IT_EOC, and ADC_START.

{
    /** Clear the End of Chain (all 16 channels converted) interrupt pending flags */
    if ( ADC->PBR & ADC_IT_EOC )
    {
        /** stop the A/D conversion chain */
        ADC->CLR0 &= ~ADC_START;
        /** clear the End Of Chain pending bit */
        ADC->PBR &= ~ADC_IT_EOC;
        /** wake up the bottom half */
    }
}

virtual const char* PikeAero::CTaskAnalogInputADC::name

(

)

[inline, virtual]

returns a CString containing an human readable name for the task

Reimplemented from PikeAero::ITask.

Definition at line 40 of file ctaskanaloginputadc.h.

{return "CTaskAnalogInputADC";}

CMachine::bit32 PikeAero::CTaskAnalogInputADC::run

(

)

[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.

called periodically by CTaskScheduler to do a piece of work. [ bottom half ]

Returns:

0 on success.

dispatch the event. dispatch() takes pointer ownership.

done working, go back to sleep

start the A/D conversion chain

Reimplemented from PikeAero::ITask.

Definition at line 108 of file ctaskanaloginputadc.cpp.

References ADC, ADC_MAX_Y, ADC_START, PikeAero::CObject::dispatch(), PikeAero::CObject::errOK, event(), PikeAero::ITask::setSleeping(), and value().

{
    /**
    ** dispatch the event. dispatch() takes pointer ownership.
    */
    CEventAnalogConversion* event = new CEventAnalogConversion(this);
    for( CMachine::ubit32 y=0; y < ADC_MAX_Y; y++ )
    {
        event->setValue(y,value(y));
    }
    dispatch( event );

    setSleeping(true);          /** done working, go back to sleep */
    ADC->CLR0 |= ADC_START;     /** start the A/D conversion chain */

    return errOK;
}

Here is the call graph for this function:

CMachine::bit32 PikeAero::CTaskAnalogInputADC::start

(

)

[virtual]

initialize the class.

perform calibration of the ADC system

start the A/D conversion chain

Reimplemented from PikeAero::ITask.

Definition at line 93 of file ctaskanaloginputadc.cpp.

References ADC, ADC_START, calibrate(), PikeAero::CObject::errOK, PikeAero::CEventQueue::installListener(), PikeAero::ITask::setSleeping(), and PikeAero::CEvent::Tick.

{
    CEventQueue::installListener(this,CEvent::Tick);
    setSleeping(true);
    /** perform calibration of the ADC system */
    calibrate();
    /** start the A/D conversion chain */
    ADC->CLR0 |= ADC_START;
    return errOK;
}

Here is the call graph for this function:

CMachine::bit32 PikeAero::CTaskAnalogInputADC::stop

(

)

[virtual]

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

Returns:

0 on success.

stop the A/D conversion chain

Reimplemented from PikeAero::ITask.

Definition at line 130 of file ctaskanaloginputadc.cpp.

References ADC, ADC_START, PikeAero::CObject::errOK, and PikeAero::ITask::setSleeping().

{
    setSleeping(true);
    ADC->CLR0 &= ~ADC_START;    /** stop the A/D conversion chain */
    return errOK;
}

Here is the call graph for this function:

CMachine::ubit32 PikeAero::CTaskAnalogInputADC::value

(

CMachine::ubit32

y

)

Fetch the value last latched from an analog channel.

Returns:

the 10 bit conversion from the data latch.

Definition at line 71 of file ctaskanaloginputadc.cpp.

References ADC.

Referenced by run().

{
    const volatile CMachine::ubit32* data = (CMachine::ubit32*)&ADC->D0;
    return ((data[(y&0x0F)])&0x3FF);
}

Here is the caller graph for this function:

---

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

• ctaskanaloginputadc.h
• ctaskanaloginputadc.cpp