qepn.h

Go to the documentation of this file.

/*****************************************************************************
* Product: QEP-nano public interface
* Last Updated for Version: 4.3.00
* Date of the Last Update:  Oct 28, 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 qepn_h
#define qepn_h

/****************************************************************************/
#define QP_VERSION      0x4300U

/****************************************************************************/
#ifndef Q_ROM             /* if NOT defined, provide the default definition */

    #define Q_ROM
#endif
#ifndef Q_ROM_VAR         /* if NOT defined, provide the default definition */

    #define Q_ROM_VAR
#endif
#ifndef Q_REENTRANT       /* if NOT defined, provide the default definition */

    #define Q_REENTRANT
#endif

/****************************************************************************/
#define Q_DIM(array_) (sizeof(array_) / sizeof(array_[0]))

/****************************************************************************/
char const Q_ROM * Q_ROM_VAR QP_getVersion(void);

typedef uint8_t QSignal;

/****************************************************************************/
#ifndef Q_PARAM_SIZE

    #define Q_PARAM_SIZE 0
#endif
#if (Q_PARAM_SIZE == 0)
#elif (Q_PARAM_SIZE == 1)

    typedef uint8_t QParam;
#elif (Q_PARAM_SIZE == 2)
    typedef uint16_t QParam;
#elif (Q_PARAM_SIZE == 4)
    typedef uint32_t QParam;
#else
    #error "Q_PARAM_SIZE defined incorrectly, expected 0, 1, 2, or 4"
#endif

typedef struct QEventTag {
    QSignal sig;                                   
#if (Q_PARAM_SIZE != 0)
    QParam par;                          
#endif
} QEvent;

/****************************************************************************/
enum QReservedSignals {
    Q_ENTRY_SIG = 1,                   
    Q_EXIT_SIG,                         
    Q_INIT_SIG,           
    Q_TIMEOUT_SIG,                          
    Q_USER_SIG      
};

/****************************************************************************/

typedef uint8_t QState;

typedef QState (*QStateHandler)(void *me);

typedef struct QFsmTag {
    QStateHandler state;                
    QEvent evt;       
} QFsm;

#define Q_SIG(me_)  (((QFsm *)(me_))->evt.sig)

#if (Q_PARAM_SIZE != 0)

#define Q_PAR(me_)  (((QFsm *)(me_))->evt.par)
#endif

#ifndef Q_NFSM

#define QFsm_ctor(me_, initial_) ((me_)->state = (initial_))

void QFsm_init(QFsm *me);

#ifndef QK_PREEMPTIVE

    void QFsm_dispatch(QFsm *me);
#else
    void QFsm_dispatch(QFsm *me) Q_REENTRANT;
#endif

#endif                                                            /* Q_NFSM */


#define Q_RET_HANDLED       ((QState)0)

#define Q_HANDLED()         (Q_RET_HANDLED)

#define Q_RET_IGNORED       ((QState)1)

#define Q_IGNORED()         (Q_RET_IGNORED)

#define Q_RET_TRAN          ((QState)2)

/*lint -e960 */     /* ignore MISRA Rule 42 (comma operator) for this macro */
#define Q_TRAN(target_)  \
    (((QFsm *)me)->state = (QStateHandler)(target_), Q_RET_TRAN)

#define Q_RET_SUPER         ((QState)3)

/*lint -e960 */     /* ignore MISRA Rule 42 (comma operator) for this macro */
#define Q_SUPER(super_)  \
    (((QFsm *)me)->state = (QStateHandler)(super_),  Q_RET_SUPER)


/****************************************************************************/
#ifndef Q_NHSM

typedef struct QFsmTag QHsm;

/* public methods */
#define QHsm_ctor(me_, initial_) ((me_)->state  = (initial_))

void QHsm_init(QHsm *me);

#ifndef QK_PREEMPTIVE

    void QHsm_dispatch(QHsm *me);
#else
    void QHsm_dispatch(QHsm *me) Q_REENTRANT;
#endif

/* protected methods... */

QState QHsm_top(QHsm *me);

#endif                                                            /* Q_NHSM */

#include "qassert.h"            /* include the QP-nano assertions (for DbC) */

#endif                                                            /* qepn_h */