qfn.h

Go to the documentation of this file.

/*****************************************************************************
* Product: QF-nano public interface
* Last Updated for Version: 4.3.00
* Date of the Last Update:  Oct 29, 2011
*
*                    Q u a n t u m     L e a P s
*                    ---------------------------
*                    innovating embedded systems
*
* Copyright (C) 2002-2011 Quantum Leaps, LLC. All rights reserved.
*
* This software may be distributed and modified under the terms of the GNU
* General Public License version 2 (GPL) as published by the Free Software
* Foundation and appearing in the file GPL.TXT included in the packaging of
* this file. Please note that GPL Section 2[b] requires that all works based
* on this software must also be made publicly available under the terms of
* the GPL ("Copyleft").
*
* Alternatively, this software may be distributed and modified under the
* terms of Quantum Leaps commercial licenses, which expressly supersede
* the GPL and are specifically designed for licensees interested in
* retaining the proprietary status of their code.
*
* Contact information:
* Quantum Leaps Web site:  http://www.quantum-leaps.com
* e-mail:                  info@quantum-leaps.com
*****************************************************************************/
#ifndef qfn_h
#define qfn_h

/****************************************************************************/
#if (QF_MAX_ACTIVE < 1) || (8 < QF_MAX_ACTIVE)
    #error "QF_MAX_ACTIVE not defined or out of range. Valid range is 1..8."
#endif
#if (defined QF_FSM_ACTIVE) && (defined Q_NFSM)
    #error "QF_FSM_ACTIVE and Q_NFSM cannot be defined at the same time."
#endif
#if (!defined QF_FSM_ACTIVE) && (defined Q_NHSM)
    #error "Q_NHSM defined without defining QF_FSM_ACTIVE."
#endif


/****************************************************************************/
/* default macros for accessing data in ROM */
#ifndef Q_ROM_BYTE

    #define Q_ROM_BYTE(rom_var_)   (rom_var_)
#endif
#ifndef Q_ROM_PTR

    #define Q_ROM_PTR(rom_var_)    (rom_var_)
#endif

#ifndef QF_TIMEEVT_CTR_SIZE

    #define QF_TIMEEVT_CTR_SIZE 0
#endif
#if (QF_TIMEEVT_CTR_SIZE == 0)
#elif (QF_TIMEEVT_CTR_SIZE == 1)
    typedef uint8_t QTimeEvtCtr;
#elif (QF_TIMEEVT_CTR_SIZE == 2)

    typedef uint16_t QTimeEvtCtr;
#elif (QF_TIMEEVT_CTR_SIZE == 4)
    typedef uint32_t QTimeEvtCtr;
#else
    #error "QF_TIMER_SIZE defined incorrectly, expected 1, 2, or 4"
#endif

/****************************************************************************/
typedef struct QActiveTag {

#ifndef QF_FSM_ACTIVE
    QHsm super;                 
#else
    QFsm super;                 
#endif
#if (QF_TIMEEVT_CTR_SIZE != 0)

    QTimeEvtCtr tickCtr;
#endif

    uint8_t prio;

    uint8_t head;

    uint8_t tail;

    uint8_t nUsed;

} QActive;


#ifndef QF_FSM_ACTIVE
    #define QActive_ctor(me_, initial_)  QHsm_ctor(&(me_)->super, initial_)
#else
    #define QActive_ctor(me_, initial_)  QFsm_ctor(&(me_)->super, initial_)
#endif


#if (Q_PARAM_SIZE != 0)

    void QActive_post(QActive *me, QSignal sig, QParam par);

    void QActive_postISR(QActive *me, QSignal sig, QParam par);
#else
    void QActive_post(QActive *me, QSignal sig);
    void QActive_postISR(QActive *me, QSignal sig);
#endif

#if (QF_TIMEEVT_CTR_SIZE != 0)

    void QF_tickISR(void);

    #define QF_tick()    QF_tickISR()

#if (QF_TIMEEVT_CTR_SIZE == 1)                 /* single-byte tick counter? */

    #define QActive_arm(me_, tout_) ((me_)->tickCtr = (QTimeEvtCtr)(tout_))

    #define QActive_disarm(me_)     ((me_)->tickCtr = (QTimeEvtCtr)0)

#else                                            /* multi-byte tick counter */

    void QActive_arm(QActive *me, QTimeEvtCtr tout);

    void QActive_disarm(QActive *me);

#endif                                        /* (QF_TIMEEVT_CTR_SIZE == 1) */

#endif                                        /* (QF_TIMEEVT_CTR_SIZE != 0) */

/* protected methods ...*/

void QF_init(void);

void QF_stop(void);

void QF_onStartup(void);

void QF_run(void);


#ifndef QK_PREEMPTIVE

void QF_onIdle(void);
#endif

/****************************************************************************/
typedef struct QActiveCBTag {
    QActive *act;        
    QEvent *queue;            
    uint8_t end;                  
} QActiveCB;

extern QActiveCB const Q_ROM Q_ROM_VAR QF_active[];

extern uint8_t volatile QF_readySet_;

#endif                                                             /* qfn_h */