فهرست منبع

refactor(freertos): Rename freertos_v8_compat.c to freertos_compatibility.c

Rename API compatibility file to be more general, and add a proper description.
Darian Leung 2 سال پیش
والد
کامیت
a67e8c1972
2فایلهای تغییر یافته به همراه11 افزوده شده و 2 حذف شده
  1. 1 1
      components/freertos/CMakeLists.txt
  2. 10 1
      components/freertos/esp_additions/freertos_compatibility.c

+ 1 - 1
components/freertos/CMakeLists.txt

@@ -103,7 +103,7 @@ list(APPEND srcs
 
 if(kernel_impl STREQUAL "FreeRTOS-Kernel")
     list(APPEND srcs
-        "esp_additions/freertos_v8_compat.c")
+        "esp_additions/freertos_compatibility.c")
 endif()
 
 if(arch STREQUAL "linux")

+ 10 - 1
components/freertos/esp_additions/freertos_v8_compat.c → components/freertos/esp_additions/freertos_compatibility.c

@@ -4,11 +4,20 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+/*
+ * FreeRTOS has changed some functions in to macros (and vice-versa) over multiple
+ * releases. This is not a breaking API change for source code, but may cause issues
+ * for pre-compiled libraries that call these removed APIs.
+ *
+ * This file maintains these legacy APIs until the next ESP-IDF major release.
+ *
+ * Todo: Clean up for ESP-IDF v6.0 (IDF-8144)
+*/
+
 #include "FreeRTOS.h"
 #include "queue.h"
 #include "semphr.h"
 
-/* This API is kept for backward ABI compatibility with prebuilt libraries against FreeRTOS v8/v9 in ESP-IDF */
 BaseType_t xQueueGenericReceive( QueueHandle_t xQueue, void * const pvBuffer, TickType_t xTicksToWait, const BaseType_t xPeek )
 {
 	if ( xPeek == pdTRUE )