/**
* @file
* @brief QP-nano configuration file.
* @description
* This header file provides the compile-time configuration of the QP-nano
* framework. A version of the `qpn_conf.h` header file needs to be provided
* with every QP-nano application.
* @cond
******************************************************************************
* Last updated for version 6.8.0
* Last updated on  2020-03-09
*
*                    Q u a n t u m  L e a P s
*                    ------------------------
*                    Modern Embedded Software
*
* Copyright (C) 2005-2020 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 3 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 <www.gnu.org/licenses>.
*
* Contact information:
* <www.state-machine.com/licensing>
* <info@state-machine.com>
******************************************************************************
* @endcond
*/
#ifndef QPN_CONF_H
#define QPN_CONF_H

/*! The size (in bytes) of the single scalar parameter representation
* in the QEvent struct. Valid values: none (0), 1, 2, or 4; default none (0).
*/
/**
* @description
* The value of this macro configures the parameter size of QP-nano Events.
* If the macro is not defined, the default of no event parameter will
* be chosen. The valid Q_PARAM_SIZE values of 1, 2, 4, or 8, correspond
* to event parameters of uint8_t, uint16_t, uint32_t, and uint64_t,
* respectively.
*
* @sa ::QEvt, #Q_PAR(), QF_post(), QF_postNoLock()
*/
#define Q_PARAM_SIZE            4U

/*! The size (in bytes) of the time event-counter representation in
* the QActive struct. Valid values: none (0), 1, 2, or 4; default none (0).
*/
/**
* @description
* The value of this macro configures the internal tick counter size of
* QP-nano Time Events. If the macro is not defined, the default of no time
* event counter will be chosen. The valid values of 1, 2, or 4, correspond
* to tick counters of uint8_t, uint16_t, and uint32_t, respectively. The
* tick counter representation determines the dynamic range of time delays
* that a Time Event can handle.
*
* @sa #QTimeEvtCtr
*/
#define QF_TIMEEVT_CTR_SIZE     2U

/*! Configuration switch to enable/disable periodic time events. */
/**
* @description
* The value of this macro configures the QF-nano timer is capable of firing
* periodically or is limited to one-shot only. The reason for not allowing
* periodic time events is that they require additional storage (inside
* QActive) for the timeout interval.@n
* @n
* When the macro QF_TIMEEVT_PERIODIC is not defined, the function
* QActive_armX() takes 3 arguments: the active object pointer, the tick
* rate of the timer, and the one-shot timeout.@n
* @n
* When the macro QF_TIMEEVT_PERIODIC is not defined, the function
* QActive_armX() takes additional 4-th argument: the interval to re-arm
* the time event automatically until QActive_disarmX() is called.
*/
#define QF_TIMEEVT_PERIODIC

/*! Configuration switch to enable/disable keeping track of QF time event
usage. */
/**
* @description
* The QF-nano keeps track of the armed time events by means of the timer-sets
* (a separate one for each clock tick rate). The main use of the timer-sets
* is to quickly determine which time events at a given tick rate are still
* armed to enter the most appropriate low-power mode of the MCU.
*/
#define QF_TIMEEVT_USAGE

/*! The preprocessor switch to enable the QK-nano scheduler locking. */
/**
* @description
* QK-nano keeps supports selective scheduler locking up to a specified
* ceiling priority. This scheduler locking can be used, for example, as
* a non-blocking mutual exclusion mechanism (formerly QK-nano mutex).
*/
#define QK_SCHED_LOCK

#endif /* QPN_CONF_H */