You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
139 lines
5.4 KiB
C
139 lines
5.4 KiB
C
//============================================================================
|
|
// QP/C Real-Time Event Framework (RTEF)
|
|
//
|
|
// Copyright (C) 2005 Quantum Leaps, LLC. All rights reserved.
|
|
//
|
|
// Q u a n t u m L e a P s
|
|
// ------------------------
|
|
// Modern Embedded Software
|
|
//
|
|
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-QL-commercial
|
|
//
|
|
// This software is dual-licensed under the terms of the open-source GNU
|
|
// General Public License (GPL) or under the terms of one of the closed-
|
|
// source Quantum Leaps commercial licenses.
|
|
//
|
|
// Redistributions in source code must retain this top-level comment block.
|
|
// Plagiarizing this software to sidestep the license obligations is illegal.
|
|
//
|
|
// NOTE:
|
|
// The GPL does NOT permit the incorporation of this code into proprietary
|
|
// programs. Please contact Quantum Leaps for commercial licensing options,
|
|
// which expressly supersede the GPL and are designed explicitly for
|
|
// closed-source distribution.
|
|
//
|
|
// Quantum Leaps contact information:
|
|
// <www.state-machine.com/licensing>
|
|
// <info@state-machine.com>
|
|
//============================================================================
|
|
#ifndef QP_PORT_H_
|
|
#define QP_PORT_H_
|
|
|
|
#include <stdint.h> // Exact-width types. WG14/N843 C99 Standard
|
|
#include <stdbool.h> // Boolean type. WG14/N843 C99 Standard
|
|
#include "qp_config.h" // QP configuration from the application
|
|
|
|
// no-return function specifier (C11 Standard)
|
|
#define Q_NORETURN _Noreturn void
|
|
|
|
// ThreadX event queue and thread types
|
|
#define QACTIVE_EQUEUE_TYPE TX_QUEUE
|
|
#define QACTIVE_THREAD_TYPE TX_THREAD
|
|
#define QACTIVE_OS_OBJ_TYPE uint8_t
|
|
|
|
// QF priority offset within ThreadX priority numbering scheme
|
|
#define QF_TX_PRIO_OFFSET 2U
|
|
|
|
#ifndef QF_MAX_ACTIVE
|
|
#define QF_MAX_ACTIVE (TX_MAX_PRIORITIES - QF_TX_PRIO_OFFSET)
|
|
#else
|
|
#error QF_MAX_ACTIVE shouild not be externally defined in QP-ThreadX port
|
|
#endif
|
|
|
|
// mapping between QF-priority and TX-priority, see NOTE1
|
|
#define QF_TO_TX_PRIO_MAP(qp_prio_) \
|
|
(TX_MAX_PRIORITIES - QF_TX_PRIO_OFFSET - (qp_prio_))
|
|
|
|
// mapping between TX-priority and QF-priority, see NOTE1
|
|
#define TX_TO_QF_PRIO_MAP(tx_prio_) \
|
|
(TX_MAX_PRIORITIES - QF_TX_PRIO_OFFSET - (tx_prio_))
|
|
|
|
// QF critical section for ThreadX, see NOTE3
|
|
#define QF_CRIT_STAT UINT int_ctrl_;
|
|
#define QF_CRIT_ENTRY() (int_ctrl_ = tx_interrupt_control(TX_INT_DISABLE))
|
|
#define QF_CRIT_EXIT() ((void)tx_interrupt_control(int_ctrl_))
|
|
#define QF_CRIT_EST() ((void)tx_interrupt_control(TX_INT_DISABLE))
|
|
|
|
// include files -------------------------------------------------------------
|
|
#include "tx_api.h" // ThreadX API
|
|
|
|
#include "qequeue.h" // QP event queue (for deferring events)
|
|
#include "qmpool.h" // QP memory pool (for event pools)
|
|
#include "qp.h" // QP platform-independent public interface
|
|
|
|
enum ThreadX_ThreadAttrs {
|
|
THREAD_NAME_ATTR
|
|
};
|
|
|
|
//============================================================================
|
|
// interface used only inside QF implementation, but not in applications
|
|
#ifdef QP_IMPL
|
|
|
|
// ThreadX-specific scheduler locking (implemented in qf_port.cpp)
|
|
#define QF_SCHED_STAT_ QFSchedLock lockStat_;
|
|
#define QF_SCHED_LOCK_(prio_) do { \
|
|
if (TX_THREAD_GET_SYSTEM_STATE() != 0U) { \
|
|
lockStat_.lockPrio = 0U; \
|
|
} else { \
|
|
QFSchedLock_(&lockStat_, (prio_)); \
|
|
} \
|
|
} while (false)
|
|
|
|
#define QF_SCHED_UNLOCK_() do { \
|
|
if (lockStat_.lockPrio != 0U) { \
|
|
QFSchedUnlock_(&lockStat_); \
|
|
} \
|
|
} while (false)
|
|
|
|
typedef struct {
|
|
uint_fast8_t lockPrio; // lock prio [QF numbering scheme]
|
|
UINT prevThre; // previoius preemption threshold
|
|
TX_THREAD *lockHolder; // the thread holding the lock
|
|
} QFSchedLock;
|
|
|
|
// internal implementation of scheduler locking/unlocking
|
|
void QFSchedLock_(QFSchedLock * const lockStat, uint_fast8_t prio);
|
|
void QFSchedUnlock_(QFSchedLock const * const lockStat);
|
|
// internal TX interrupt counter for TX_THREAD_GET_SYSTEM_STATE()
|
|
extern ULONG volatile _tx_thread_system_state;
|
|
|
|
// native QF event pool customization
|
|
#define QF_EPOOL_TYPE_ QMPool
|
|
#define QF_EPOOL_INIT_(p_, poolSto_, poolSize_, evtSize_) \
|
|
(QMPool_init(&(p_), (poolSto_), (poolSize_), (evtSize_)))
|
|
#define QF_EPOOL_EVENT_SIZE_(p_) ((uint_fast16_t)(p_).blockSize)
|
|
#define QF_EPOOL_GET_(p_, e_, m_, qsId_) \
|
|
((e_) = (QEvt *)QMPool_get(&(p_), (m_), (qsId_)))
|
|
#define QF_EPOOL_PUT_(p_, e_, qsId_) \
|
|
(QMPool_put(&(p_), (e_), (qsId_)))
|
|
|
|
#endif // ifdef QP_IMPL
|
|
|
|
//============================================================================
|
|
// NOTE1:
|
|
// Because the ThreadX priority numbering is "upside down" compared
|
|
// to the QP priority numbering, the ThreadX priority for an active object
|
|
// thread is calculated as specified in the macro QF_TO_TX_PRIO_MAP(prio_).
|
|
// This mapping leaves the QF_TX_PRIO_OFFSET number of lowest-priority
|
|
// ThreadX threads NOT available as threads for QP Active Objects. The use
|
|
// of such lowest-priority ThredX threads is, for example, to emulate idle
|
|
// thread, etc.
|
|
//
|
|
// NOTE3:
|
|
// The ThreadX critical section must be able to nest, which is the case with
|
|
// the tx_interrupt_control() API.
|
|
//
|
|
|
|
#endif // QP_PORT_H_
|
|
|