qs_pkg.h

Go to the documentation of this file.

/*****************************************************************************
* Product:  QS/C
* Last Updated for Version: 4.5.04
* Date of the Last Update:  Feb 01, 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 qs_pkg_h
#define qs_pkg_h

#include "qs_port.h"                                             /* QS port */

typedef uint16_t QSCtr;

/*..........................................................................*/
#define QS_INSERT_BYTE(b_) \
    QS_PTR_AT_(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_PTR_AT_(i_) (QS_ring_[(i_)])

#define QS_PTR_INC_(ptr_) (++(ptr_))

#define QS_FRAME    ((uint8_t)0x7E)

#define QS_ESC      ((uint8_t)0x7D)

#define QS_ESC_XOR  ((uint8_t)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_;           
#endif                                                          /* qs_pkg_h */