PikeAero::CCommunicationUART Class Reference

#include <ccommunicationuart.h>

Inheritance diagram for PikeAero::CCommunicationUART:

[legend]

Collaboration diagram for PikeAero::CCommunicationUART:

[legend]

Public Member Functions
	CCommunicationUART (CMachine::InterruptVector vector, UART_TypeDef *UARTx, CMachine::ubit32 baud=9600)
void	disableTxInterrupts ()
	enables or disables transmitter interrutpts.
void	enableTxInterrupts ()
	enables or disables transmitter interrutpts.
virtual void	irq (CMachine::InterruptVector v)
	receive a hardware interrupt.
void	setBaud (CMachine::ubit32 baud)
	set the baud rate.
void	setLoopBack (bool enabled=true)
	enables or disables loopback test mode.
virtual CMachine::ubit8	tx (CMachine::ubit8 ch)
	transmit a single byte - may yield CPU time if transmitter ring buffer is full.
virtual	~CCommunicationUART ()
Private Attributes
UART_TypeDef *	mUART

---

Detailed Description

Implements a UART (Universal Asyncronous Receiver Transmitter) interface.

Author:

Michael Sharkey <mike@pikeaero.com>

Definition at line 32 of file ccommunicationuart.h.

---

Constructor & Destructor Documentation

PikeAero::CCommunicationUART::CCommunicationUART	(	CMachine::InterruptVector	vector,
		UART_TypeDef *	UARTx,
		CMachine::ubit32	baud = 9600
	)

Install self into interupt vector

Stop and Initialize the UART

Choose 8N1, enable rx, enable FIFOs, enable uart

Reset the FIFOs

Configure BaudRate

Set the timeout register

Set interrupt enable mask

Disable transmitter interrupts until we have some data to transmit...

Definition at line 27 of file ccommunicationuart.cpp.

References PikeAero::UART_TypeDef::CR, disableTxInterrupts(), PikeAero::UART_TypeDef::IER, PikeAero::CMachine::installVectorIRQ(), mUART, PikeAero::UART_TypeDef::RxRSTR, setBaud(), PikeAero::UART_TypeDef::TOR, PikeAero::UART_TypeDef::TxRSTR, UART_FIFO, UART_IT_FrameError, UART_IT_OverrunError, UART_IT_ParityError, UART_IT_RxBufNotEmpty, UART_IT_RxHalfFull, UART_IT_TimeOutNotEmpty, UART_Mode_8D, UART_RUN, UART_Rx_EN, UART_RxFIFO, UART_StopBits_1, and UART_TxFIFO.

 : inherited()
 , mUART(UARTx)
{
    /** Install self into interupt vector */
    CMachine::installVectorIRQ(vector,this);

    /** Stop and Initialize the UART */
    mUART->IER = 0;
    mUART->CR = 0;
    /** Choose 8N1, enable rx, enable FIFOs, enable uart */
    mUART->CR = ( UART_Mode_8D | UART_StopBits_1 | UART_Rx_EN | UART_FIFO | UART_RUN );
    /** Reset the FIFOs */
    mUART->TxRSTR = UART_TxFIFO;
    mUART->RxRSTR = UART_RxFIFO;
    /** Configure BaudRate */
    setBaud( baud );
    /** Set the timeout register */
    mUART->TOR = 0x00FF;
    /** Set interrupt enable mask */
    mUART->IER = ( UART_IT_RxHalfFull | UART_IT_OverrunError | UART_IT_FrameError | UART_IT_ParityError | UART_IT_RxBufNotEmpty | UART_IT_TimeOutNotEmpty );
    /** Disable transmitter interrupts until we have some data to transmit... */
    disableTxInterrupts();

}

Here is the call graph for this function:

PikeAero::CCommunicationUART::~CCommunicationUART

(

)

[virtual]

Reset the FIFOs

Stop and Initialize the UART

Remove self from interrupt vector

Definition at line 53 of file ccommunicationuart.cpp.

References PikeAero::UART_TypeDef::CR, PikeAero::UART_TypeDef::IER, mUART, PikeAero::CMachine::removeVectorIRQ(), PikeAero::UART_TypeDef::RxRSTR, PikeAero::UART_TypeDef::TxRSTR, UART_RxFIFO, and UART_TxFIFO.

{
    /** Reset the FIFOs */
    mUART->TxRSTR = UART_TxFIFO;
    mUART->RxRSTR = UART_RxFIFO;
    /** Stop and Initialize the UART */
    mUART->IER = 0;
    mUART->CR = 0;

    /** Remove self from interrupt vector */
    CMachine::removeVectorIRQ(this);
}

Here is the call graph for this function:

---

Member Function Documentation

void PikeAero::CCommunicationUART::disableTxInterrupts

(

)

[inline]

enables or disables transmitter interrutpts.

Definition at line 70 of file ccommunicationuart.h.

References PikeAero::UART_TypeDef::IER, mUART, UART_IT_TxEmpty, and UART_IT_TxHalfEmpty.

Referenced by CCommunicationUART(), and irq().

        {
            mUART->IER &= ~( UART_IT_TxEmpty | UART_IT_TxHalfEmpty );
        }

Here is the caller graph for this function:

void PikeAero::CCommunicationUART::enableTxInterrupts

(

)

[inline]

enables or disables transmitter interrutpts.

Definition at line 62 of file ccommunicationuart.h.

References PikeAero::UART_TypeDef::IER, mUART, UART_IT_TxEmpty, and UART_IT_TxHalfEmpty.

Referenced by tx().

        {
            mUART->IER |= ( UART_IT_TxEmpty | UART_IT_TxHalfEmpty );
        }

Here is the caller graph for this function:

void PikeAero::CCommunicationUART::irq

(

CMachine::InterruptVector

v

)

[virtual]

receive a hardware interrupt.

receive a hardware interrupt.g

RX data ...

TX data ...

Reimplemented from PikeAero::CObject.

Definition at line 92 of file ccommunicationuart.cpp.

References disableTxInterrupts(), PikeAero::CRingBuffer::insert(), mUART, PikeAero::CRingBuffer::remove(), PikeAero::UART_TypeDef::RxBUFR, PikeAero::CCommunication::rxRingBuffer(), PikeAero::UART_TypeDef::SR, PikeAero::UART_TypeDef::TxBUFR, PikeAero::CCommunication::txRingBuffer(), UART_SR_FrameError, UART_SR_ParityError, UART_SR_RxBufNotEmpty, UART_SR_TimeOutNotEmpty, and UART_SR_TxFull.

{
    /** RX data ... */
    while ( (mUART->SR & (UART_SR_RxBufNotEmpty | UART_SR_FrameError | UART_SR_ParityError | UART_SR_TimeOutNotEmpty)) != 0 && !rxRingBuffer()->full() )
    {
        CMachine::ubit16 ch = mUART->RxBUFR;
        if ( (ch & 0x0200) == 0 ) /* if no framing error... */
        {
            rxRingBuffer()->insert((CMachine::ubit8)(ch&0x00FF));
        }
    }

    /** TX data ... */
    while ( ((mUART->SR & UART_SR_TxFull) == 0) && !txRingBuffer()->empty() )
    {
        mUART->TxBUFR = txRingBuffer()->remove();
    }
    if ( txRingBuffer()->empty() )
    {
        disableTxInterrupts();
    }
}

Here is the call graph for this function:

void PikeAero::CCommunicationUART::setBaud

(

CMachine::ubit32

baud

)

set the baud rate.

Definition at line 69 of file ccommunicationuart.cpp.

References PikeAero::UART_TypeDef::BR, PikeAero::CMachine::fMCLK(), and mUART.

Referenced by CCommunicationUART().

{
    mUART->BR = static_cast<CMachine::ubit16>( ( CMachine::fMCLK() / (16 * baud) ) & 0x0000FFFF );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void PikeAero::CCommunicationUART::setLoopBack

(

bool

enabled = true

)

[inline]

enables or disables loopback test mode.

Definition at line 51 of file ccommunicationuart.h.

References PikeAero::UART_TypeDef::CR, mUART, and UART_LoopBack.

        {
            if ( enabled )
                mUART->CR |= UART_LoopBack;
            else
                mUART->CR &= ~UART_LoopBack;
        }

CMachine::ubit8 PikeAero::CCommunicationUART::tx

(

CMachine::ubit8

ch

)

[virtual]

transmit a single byte - may yield CPU time if transmitter ring buffer is full.

Returns:

The same byte.

Reimplemented from PikeAero::CCommunication.

Reimplemented in PikeAero::CCommunicationPacket.

Definition at line 78 of file ccommunicationuart.cpp.

References enableTxInterrupts(), PikeAero::CCommunication::txRingBuffer(), and PikeAero::CTaskScheduler::yield().

{
    while ( !txRingBuffer()->insert(ch) )
    {
        CTaskScheduler::yield();
        enableTxInterrupts();
    }
    enableTxInterrupts();
    return ch;
}

Here is the call graph for this function:

---

Field Documentation

UART_TypeDef* PikeAero::CCommunicationUART::mUART [private]

Definition at line 82 of file ccommunicationuart.h.

Referenced by CCommunicationUART(), disableTxInterrupts(), enableTxInterrupts(), irq(), setBaud(), setLoopBack(), and ~CCommunicationUART().

---

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

• ccommunicationuart.h
• ccommunicationuart.cpp