qs_pkg.h

Go to the documentation of this file.

// Product: QS/C++
// Last Updated for Version: 4.2.00
// Date of the Last Update:  Jul 05, 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 qs_pkg_h
#define qs_pkg_h


#include "qs_port.h"                                                // QS port

#ifdef Q_USE_NAMESPACE
namespace QP {
#endif

typedef uint16_t QSCtr;

#define QS_INSERT_BYTE(b_) \
    QS_ring_[QS_head_] = (b_); \
    ++QS_head_; \
    if (QS_head_ == QS_end_) { \
        QS_head_ = (QSCtr)0; \
    } \
    ++QS_used_;

#define QS_INSERT_ESC_BYTE(b_) \
    QS_chksum_ = (uint8_t)(QS_chksum_ + (b_)); \
    if (((b_) == QS_FRAME) || ((b_) == QS_ESC)) { \
        QS_INSERT_BYTE(QS_ESC) \
        QS_INSERT_BYTE((uint8_t)((b_) ^ QS_ESC_XOR)) \
    } \
    else { \
        QS_INSERT_BYTE(b_) \
    }

#define QS_INSERT_CHKSUM_BYTE() \
    QS_chksum_ = (uint8_t)~QS_chksum_; \
    if ((QS_chksum_ == QS_FRAME) || (QS_chksum_ == QS_ESC)) { \
        QS_INSERT_BYTE(QS_ESC) \
        QS_INSERT_BYTE((uint8_t)(QS_chksum_ ^ QS_ESC_XOR)) \
    } \
    else { \
        QS_INSERT_BYTE(QS_chksum_) \
    }


#define QS_FRAME    ((uint8_t)0x7E)

#define QS_ESC      ((uint8_t)0x7D)

#define QS_ESC_XOR  0x20

#ifndef Q_ROM_BYTE













    #define Q_ROM_BYTE(rom_var_)   (rom_var_)
#endif

//............................................................................
extern uint8_t *QS_ring_;         
extern QSCtr QS_end_;                
extern QSCtr QS_head_;         
extern QSCtr QS_tail_;       
extern QSCtr QS_used_;       
extern uint8_t QS_seq_;                        
extern uint8_t QS_chksum_;             
extern uint8_t QS_full_;              


#ifdef Q_USE_NAMESPACE
}                                                              // namespace QP
#endif

#endif                                                             // qs_pkg_h