Kernel.hpp

/*
 * FreeRTOS-Cpp
 * Copyright (C) 2021 Jon Enz. All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * https://github.com/jonenz/FreeRTOS-Cpp
 */
 
#ifndef FREERTOS_KERNEL_HPP
#define FREERTOS_KERNEL_HPP
 
#include "FreeRTOS.h"
#include "task.h"
 
namespace FreeRTOS {
 
namespace Kernel {
enum class SchedulerState : BaseType_t {
  Suspended = taskSCHEDULER_SUSPENDED,
  NotStarted = taskSCHEDULER_NOT_STARTED,
  Running = taskSCHEDULER_RUNNING,
};
 
inline constexpr char versionNumber[] = tskKERNEL_VERSION_NUMBER;
inline constexpr BaseType_t versionMajor = tskKERNEL_VERSION_MAJOR;
inline constexpr BaseType_t versionMinor = tskKERNEL_VERSION_MINOR;
inline constexpr BaseType_t versionBuild = tskKERNEL_VERSION_BUILD;
 
#if (INCLUDE_xTaskGetSchedulerState == 1)
inline SchedulerState getSchedulerState() {
  return static_cast<SchedulerState>(xTaskGetSchedulerState());
}
#endif /* INCLUDE_xTaskGetSchedulerState */
 
inline UBaseType_t getNumberOfTasks() {
  return uxTaskGetNumberOfTasks();
}
 
#if (INCLUDE_xTaskGetIdleTaskHandle == 1 && configGENERATE_RUN_TIME_STATS == 1)
inline TickType_t getIdleRunTimeCounter() {
  return xTaskGetIdleRunTimeCounter();
}
#endif /* INCLUDE_xTaskGetIdleTaskHandle && configGENERATE_RUN_TIME_STATS*/
 
inline TickType_t getTickCount() {
  return xTaskGetTickCount();
}
 
inline TickType_t getTickCountFromISR() {
  return xTaskGetTickCountFromISR();
}
 
inline void yield() {
  taskYIELD();
}
 
inline void enterCritical() {
  taskENTER_CRITICAL();
}
 
inline uint32_t enterCriticalFromISR() {
  return taskENTER_CRITICAL_FROM_ISR();
}
 
inline void exitCritical() {
  taskEXIT_CRITICAL();
}
 
inline void exitCriticalFromISR(const uint32_t interruptStatus) {
  taskEXIT_CRITICAL_FROM_ISR(interruptStatus);
}
 
inline void disableInterrupts() {
  taskDISABLE_INTERRUPTS();
}
 
inline void enableInterrupts() {
  taskENABLE_INTERRUPTS();
}
 
inline void startScheduler() {
  vTaskStartScheduler();
}
 
inline void endScheduler() {
  vTaskEndScheduler();
}
 
inline void suspendAll() {
  vTaskSuspendAll();
}
 
inline bool resumeAll() {
  return (xTaskResumeAll() == pdTRUE);
}
 
#if (configUSE_TICKLESS_IDLE != 0)
inline void stepTick(const TickType_t ticksToJump) {
  vTaskStepTick(ticksToJump);
}
#endif /* configUSE_TICKLESS_IDLE */
 
inline bool catchUpTicks(const TickType_t ticksToCatchUp) {
  return (xTaskCatchUpTicks(ticksToCatchUp) == pdTRUE);
}
}  // namespace Kernel
 
}  // namespace FreeRTOS
 
#endif  // FREERTOS_KERNEL_HPP