qpc/ports/arm-cr/qxk/iar/qf_port.h
Quantum Leaps 28ef7ac6ce 5.9.0
2017-05-17 13:16:32 -04:00

90 lines
3.4 KiB
C

/**
* @file
* @brief QF/C port to Cortex-R, dual-mode QXK kernel, IAR-ARM toolset
* @cond
******************************************************************************
* Last Updated for Version: 5.7.1
* Date of the Last Update: 2016-09-22
*
* Q u a n t u m L e a P s
* ---------------------------
* innovating embedded systems
*
* Copyright (C) 2002-2016 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 <http://www.gnu.org/licenses/>.
*
* Contact information:
* https://state-machine.com
* mailto:info@state-machine.com
******************************************************************************
* @endcond
*/
#ifndef qf_port_h
#define qf_port_h
/* The maximum number of active objects in the application, see NOTE1 */
#define QF_MAX_ACTIVE 32
/* The maximum number of system clock tick rates */
#define QF_MAX_TICK_RATE 2
/* QF interrupt disable/enable, see NOTE2 */
#define QF_INT_DISABLE() __disable_irq()
#define QF_INT_ENABLE() __enable_irq()
#define QF_INT_ENABLE_ALL() __enable_interrupt()
/* Cortex-R provide the CLZ instruction for fast LOG2 */
#define QF_LOG2(n_) ((uint8_t)(32U - __CLZ(n_)))
/* QF critical section entry/exit, see NOTE3 */
#define QF_CRIT_STAT_TYPE uint32_t
#define QF_CRIT_ENTRY(status_) do { \
(status_) = __get_CPSR(); \
QF_INT_DISABLE(); \
} while (0)
#define QF_CRIT_EXIT(status_) __set_CPSR((status_))
#define QF_CRIT_EXIT_NOP() __ISB()
#include <intrinsics.h> /* IAR intrinsic functions */
#include "qep_port.h" /* QEP port */
#include "qxk_port.h" /* QXK port */
#include "qf.h" /* QF platform-independent public interface */
#include "qxthread.h" /* QXK extended thread interface */
/*****************************************************************************
* NOTE1:
* The maximum number of active objects QF_MAX_ACTIVE can be increased
* up to 63, if necessary. Here it is set to a lower level to save some RAM.
*
* NOTE2:
* The FIQ-type interrupts are NEVER disabled in this port, so the FIQ is
* a "kernel-unaware" interrupt. If the FIQ is ever used in the application,
* it must be an "__arm __fiq"-type function. For this to work, the FIQ
* stack needs to be initialized.
*
* NOTE3:
* This port implements the "save and restore" interrupt status policy,
* which again never disables the FIQ-type interrupts. This policy allows
* for nesting critical sections, which is necessary inside IRQ-type
* interrupts that run with interrupts (IRQ) disabled.
*/
#endif /* qf_port_h */