Introduced header to cope with the environment (device, tool, configuration) specifics (#35).

Author: VladimirUmek

ARM.CMSIS-FreeRTOS.pdsc

@@ -9,6 +9,7 @@
 
   <releases>
     <release version="10.2.1-dev2">
+      - Moved device and environment specifics into separate header
       - Added implementation of the osMemoryPool functions using FreeRTOS
       - Removed Cortex-A example (will be available in separate pack)
     </release>

CMSIS/RTOS2/FreeRTOS/Include/freertos_os2.h

@@ -0,0 +1,88 @@
+/* --------------------------------------------------------------------------
+ * Copyright (c) 2013-2019 Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the License); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *      Name:    freertos_os2.h
+ *      Purpose: CMSIS RTOS2 wrapper for FreeRTOS
+ *
+ *---------------------------------------------------------------------------*/
+
+#ifndef FREERTOS_OS2_H_
+#define FREERTOS_OS2_H_
+
+#include <string.h>
+#include <stdint.h>
+
+#include "FreeRTOS.h"                   // ARM.FreeRTOS::RTOS:Core
+
+#include "RTE_Components.h"             // Component selection
+#include CMSIS_device_header
+
+/* Configuration and component setup check */
+#if defined(RTE_Compiler_EventRecorder)
+  #define USE_TRACE_EVENT_RECORDER
+#endif
+
+#if defined(RTE_RTOS_FreeRTOS_HEAP_1)
+  #define USE_FreeRTOS_HEAP_1
+#endif
+
+#if defined(RTE_RTOS_FreeRTOS_HEAP_5)
+  #define USE_FreeRTOS_HEAP_5
+#endif
+
+/* Check FreeRTOSConfig.h include definitions.
+   Note: CMSIS-RTOS API requires functions included by using following definitions.
+         In case if certain API function is not used compiler will optimize it away.
+*/
+#if (INCLUDE_xSemaphoreGetMutexHolder == 0)
+  #error "Definition INCLUDE_xSemaphoreGetMutexHolder must be non-zero to implement Mutex Management API."
+#endif
+#if (INCLUDE_vTaskDelay == 0)
+  #error "Definition INCLUDE_vTaskDelay must be non-zero to implement Generic Wait Functions API."
+#endif
+#if (INCLUDE_vTaskDelayUntil == 0)
+  #error "Definition INCLUDE_vTaskDelayUntil must be non-zero to implement Generic Wait Functions API."
+#endif
+#if (INCLUDE_vTaskDelete == 0)
+  #error "Definition INCLUDE_vTaskDelete must be non-zero to implement Thread Management API."
+#endif
+#if (INCLUDE_xTaskGetCurrentTaskHandle == 0)
+  #error "Definition INCLUDE_xTaskGetCurrentTaskHandle must be non-zero to implement Thread Management API."
+#endif
+#if (INCLUDE_xTaskGetSchedulerState == 0)
+  #error "Definition INCLUDE_xTaskGetSchedulerState must be non-zero to implement Kernel Information and Control API."
+#endif
+#if (INCLUDE_uxTaskGetStackHighWaterMark == 0)
+  #error "Definition INCLUDE_uxTaskGetStackHighWaterMark must be non-zero to implement Thread Management API."
+#endif
+#if (INCLUDE_uxTaskPriorityGet == 0)
+  #error "Definition INCLUDE_uxTaskPriorityGet must be non-zero to implement Thread Management API."
+#endif
+#if (INCLUDE_vTaskPrioritySet == 0)
+  #error "Definition INCLUDE_vTaskPrioritySet must be non-zero to implement Thread Management API."
+#endif
+#if (INCLUDE_eTaskGetState == 0)
+  #error "Definition INCLUDE_eTaskGetState must be non-zero to implement Thread Management API."
+#endif
+#if (INCLUDE_vTaskSuspend == 0)
+  #error "Definition INCLUDE_vTaskSuspend must be non-zero to implement Kernel Information and Control API."
+#endif
+#if (INCLUDE_xTimerPendFunctionCall == 0)
+  #error "Definition INCLUDE_xTimerPendFunctionCall must be non-zero to implement Event Flags API."
+#endif
+
+#endif /* FREERTOS_OS2_H_ */

CMSIS/RTOS2/FreeRTOS/Source/cmsis_os2.c

@@ -22,18 +22,17 @@
 
 #include <string.h>
 
-#include "RTE_Components.h"             // Component selection
-
 #include "cmsis_os2.h"                  // ::CMSIS:RTOS2
-#include "cmsis_compiler.h"
-#include "os_tick.h"
+#include "cmsis_compiler.h"             // Compiler agnostic definitions
+#include "os_tick.h"                    // OS Tick API
 
 #include "FreeRTOS.h"                   // ARM.FreeRTOS::RTOS:Core
 #include "task.h"                       // ARM.FreeRTOS::RTOS:Core
 #include "event_groups.h"               // ARM.FreeRTOS::RTOS:Event Groups
 #include "semphr.h"                     // ARM.FreeRTOS::RTOS:Core
 
-#include "freertos_mpool.h"
+#include "freertos_mpool.h"             // osMemoryPool definitions
+#include "freertos_os2.h"               // Configuration check and setup
 
 /*---------------------------------------------------------------------------*/
 #ifndef __ARM_ARCH_6M__
@@ -112,7 +111,7 @@ static osKernelState_t KernelState = osKernelInactive;
   definition configHEAP_5_REGIONS as parameter. Overriding configHEAP_5_REGIONS
   is possible by defining it globally or in FreeRTOSConfig.h.
 */
-#if defined(RTE_RTOS_FreeRTOS_HEAP_5)
+#if defined(USE_FreeRTOS_HEAP_5)
 #if (configAPPLICATION_ALLOCATED_HEAP == 0)
   /*
     FreeRTOS heap is not defined by the application.
@@ -142,7 +141,7 @@ static osKernelState_t KernelState = osKernelInactive;
   */
   #define HEAP_5_REGION_SETUP   0
 #endif /* configAPPLICATION_ALLOCATED_HEAP */
-#endif /* RTE_RTOS_FreeRTOS_HEAP_5 */
+#endif /* USE_FreeRTOS_HEAP_5 */
 
 #if defined(SysTick)
 #undef SysTick_Handler
@@ -195,10 +194,10 @@ osStatus_t osKernelInitialize (void) {
   }
   else {
     if (KernelState == osKernelInactive) {
-      #if defined(RTE_Compiler_EventRecorder)
+      #if defined(USE_TRACE_EVENT_RECORDER)
         EvrFreeRTOSSetup(0U);
       #endif
-      #if defined(RTE_RTOS_FreeRTOS_HEAP_5) && (HEAP_5_REGION_SETUP == 1)
+      #if defined(USE_FreeRTOS_HEAP_5) && (HEAP_5_REGION_SETUP == 1)
         vPortDefineHeapRegions (configHEAP_5_REGIONS);
       #endif
       KernelState = osKernelReady;
@@ -618,7 +617,7 @@ osStatus_t osThreadResume (osThreadId_t thread_id) {
 }
 
 __NO_RETURN void osThreadExit (void) {
-#ifndef RTE_RTOS_FreeRTOS_HEAP_1
+#ifndef USE_FreeRTOS_HEAP_1
   vTaskDelete (NULL);
 #endif
   for (;;);
@@ -627,7 +626,7 @@ __NO_RETURN void osThreadExit (void) {
 osStatus_t osThreadTerminate (osThreadId_t thread_id) {
   TaskHandle_t hTask = (TaskHandle_t)thread_id;
   osStatus_t stat;
-#ifndef RTE_RTOS_FreeRTOS_HEAP_1
+#ifndef USE_FreeRTOS_HEAP_1
   eTaskState tstate;
 
   if (IS_IRQ()) {
@@ -1035,7 +1034,7 @@ uint32_t osTimerIsRunning (osTimerId_t timer_id) {
 osStatus_t osTimerDelete (osTimerId_t timer_id) {
   TimerHandle_t hTimer = (TimerHandle_t)timer_id;
   osStatus_t stat;
-#ifndef RTE_RTOS_FreeRTOS_HEAP_1
+#ifndef USE_FreeRTOS_HEAP_1
   TimerCallback_t *callb;
 
   if (IS_IRQ()) {
@@ -1216,7 +1215,7 @@ osStatus_t osEventFlagsDelete (osEventFlagsId_t ef_id) {
   EventGroupHandle_t hEventGroup = (EventGroupHandle_t)ef_id;
   osStatus_t stat;
 
-#ifndef RTE_RTOS_FreeRTOS_HEAP_1
+#ifndef USE_FreeRTOS_HEAP_1
   if (IS_IRQ()) {
     stat = osErrorISR;
   }
@@ -1406,7 +1405,7 @@ osThreadId_t osMutexGetOwner (osMutexId_t mutex_id) {
 
 osStatus_t osMutexDelete (osMutexId_t mutex_id) {
   osStatus_t stat;
-#ifndef RTE_RTOS_FreeRTOS_HEAP_1
+#ifndef USE_FreeRTOS_HEAP_1
   SemaphoreHandle_t hMutex;
 
   hMutex = (SemaphoreHandle_t)((uint32_t)mutex_id & ~1U);
@@ -1585,7 +1584,7 @@ osStatus_t osSemaphoreDelete (osSemaphoreId_t semaphore_id) {
   SemaphoreHandle_t hSemaphore = (SemaphoreHandle_t)semaphore_id;
   osStatus_t stat;
 
-#ifndef RTE_RTOS_FreeRTOS_HEAP_1
+#ifndef USE_FreeRTOS_HEAP_1
   if (IS_IRQ()) {
     stat = osErrorISR;
   }
@@ -1834,7 +1833,7 @@ osStatus_t osMessageQueueDelete (osMessageQueueId_t mq_id) {
   QueueHandle_t hQueue = (QueueHandle_t)mq_id;
   osStatus_t stat;
 
-#ifndef RTE_RTOS_FreeRTOS_HEAP_1
+#ifndef USE_FreeRTOS_HEAP_1
   if (IS_IRQ()) {
     stat = osErrorISR;
   }