qepn.h

Go to the documentation of this file.

/*****************************************************************************
* Product: QP-nano
* Last Updated for Version: 4.5.04
* Date of the Last Update:  Feb 02, 2013
*
*                    Q u a n t u m     L e a P s
*                    ---------------------------
*                    innovating embedded systems
*
* Copyright (C) 2002-2013 Quantum Leaps, LLC. All rights reserved.
*
* This program is open source software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* Alternatively, this program may be distributed and modified under the
* terms of Quantum Leaps commercial licenses, which expressly supersede
* the GNU General Public License and are specifically designed for
* licensees interested in retaining the proprietary status of their code.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Contact information:
* Quantum Leaps Web sites: http://www.quantum-leaps.com
*                          http://www.state-machine.com
* e-mail:                  info@quantum-leaps.com
*****************************************************************************/
#ifndef qepn_h
#define qepn_h

/****************************************************************************/
#define QP_VERSION      0x4504U

/****************************************************************************/
#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]))

/****************************************************************************/
/* typedefs for basic numerical types; MISRA-C 2004 rule 6.3(req).          */
typedef char char_t;

typedef float float32_t;

typedef double float64_t;

#define Q_UINT2PTR_CAST(type_, uint_)  ((type_ *)(uint_))

/****************************************************************************/
char_t 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 QEvtTag {
    QSignal sig;                                   
#if (Q_PARAM_SIZE != 0)
    QParam par;                          
#endif
} QEvt;

/****************************************************************************/
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);

#define Q_STATE_CAST(handler_)  ((QStateHandler)(handler_))

typedef struct QFsmTag {
    QStateHandler state;                
    QStateHandler temp; 
    QEvt 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_) do { \
    (me_)->state = Q_STATE_CAST(0); \
    (me_)->temp  = (initial_); \
} while (0)

void QFsm_init(QFsm * const me);

#ifndef QK_PREEMPTIVE

    void QFsm_dispatch(QFsm * const me);
#else
    void QFsm_dispatch(QFsm * const 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)

#define Q_TRAN(target_)  \
    (((QFsm *)me)->temp = Q_STATE_CAST(target_), Q_RET_TRAN)

#define Q_RET_SUPER         ((QState)3)

#define Q_SUPER(super_)  \
    (((QHsm *)me)->temp = Q_STATE_CAST(super_),  Q_RET_SUPER)

#define Q_RET_UNHANDLED    ((QState)4)

#define Q_UNHANDLED()      (Q_RET_UNHANDLED)


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

typedef struct QFsmTag QHsm;

/* public methods */
#define QHsm_ctor(me_, initial_) do { \
    (me_)->state = Q_STATE_CAST(&QHsm_top); \
    (me_)->temp  = (initial_); \
} while (0)

#define QHsm_state(me_) (Q_STATE_CAST((me_)->state))

void QHsm_init(QHsm * const me);

#ifndef QK_PREEMPTIVE

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

/* protected methods... */

QState QHsm_top(void const * const me);

#endif                                                            /* Q_NHSM */

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

/****************************************************************************/
#ifndef Q_NQEVENT
    typedef QEvt QEvent;             
#endif

#endif                                                            /* qepn_h */