qpc/ports/ucos-ii/qf_port.h
2019-10-27 11:57:33 -04:00

119 lines
4.0 KiB
C

/**
* @file
* @brief QF/C generic port to uC/OS-II V2.92
* @cond
******************************************************************************
* Last Updated for Version: 6.0.4
* Date of the Last Update: 2018-01-07
*
* Q u a n t u m L e a P s
* ---------------------------
* innovating embedded systems
*
* Copyright (C) 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
/* uC/OS-II event queue and thread types */
#define QF_EQUEUE_TYPE OS_EVENT *
#define QF_THREAD_TYPE uint32_t
/* The maximum number of active objects in the application */
#define QF_MAX_ACTIVE ((OS_LOWEST_PRIO - 1 < 64) ? (OS_LOWEST_PRIO - 1) : 64)
/* uC/OS-II critical section operations (critical section type 3), NOTE1 */
#define QF_CRIT_STAT_TYPE OS_CPU_SR
#define QF_CRIT_ENTRY(stat_) ((stat_) = OS_CPU_SR_Save())
#define QF_CRIT_EXIT(stat_) OS_CPU_SR_Restore(stat_)
#include "ucos_ii.h" /* uC/OS-II API */
#include "qep_port.h" /* QEP port */
#include "qequeue.h" /* native QF event queue for deferring events */
#include "qf.h" /* QF platform-independent public interface */
/*****************************************************************************
* interface used only inside QF, but not in applications
*/
#ifdef QP_IMPL
/* uC/OS-II-specific scheduler locking, see NOTE2 */
#define QF_SCHED_STAT_
#define QF_SCHED_LOCK_(dummy) do { \
if (OSIntNesting == (INT8U)0) { \
OSSchedLock(); \
} \
} while (0)
#define QF_SCHED_UNLOCK_() do { \
if (OSIntNesting == (INT8U)0) { \
OSSchedUnlock(); \
} \
} while (0)
/* uC/OS-II event pool operations... */
#define QF_EPOOL_TYPE_ OS_MEM*
#define QF_EPOOL_INIT_(pool_, poolSto_, poolSize_, evtSize_) do { \
INT8U err; \
(pool_) = OSMemCreate((poolSto_), (INT32U)((poolSize_)/(evtSize_)), \
(INT32U)(evtSize_), &err); \
Q_ASSERT(err == OS_ERR_NONE); \
} while (0)
#define QF_EPOOL_EVENT_SIZE_(pool_) ((pool_)->OSMemBlkSize)
#define QF_EPOOL_GET_(pool_, e_, m_) do { \
QF_CRIT_STAT_ \
QF_CRIT_ENTRY_(); \
if ((pool_)->OSMemNFree > (m_)) { \
INT8U err; \
(e_) = (QEvt *)OSMemGet((pool_), &err); \
Q_ASSERT(err == OS_ERR_NONE); \
} \
else { \
(e_) = (QEvt *)0; \
} \
QF_CRIT_EXIT_(); \
} while (0)
#define QF_EPOOL_PUT_(pool_, e_) \
Q_ALLEGE(OSMemPut((pool_), (void *)(e_)) == OS_ERR_NONE)
#endif /* ifdef QP_IMPL */
#endif /* QF_PORT_H */
/*****************************************************************************
* NOTE1:
* uC/OS-II critical section must be able to nest.
*
* NOTE2:
* uC/OS-II provides only global scheduler locking for all thread priorities
* by means of OSSchedLock() and OSSchedUnlock(). Therefore, locking the
* scheduler only up to the specified lock priority is not supported.
*/