From 81ec5b4d85c21b20cc1d2d770e2b4ef9fd23ab94 Mon Sep 17 00:00:00 2001 From: "Ching-Hsin,Lee" Date: Fri, 9 Aug 2024 13:28:15 +0800 Subject: [PATCH] Fix freertos.org link in the source and doxygen files --- docs/doxygen/pages.dox | 8 ++++---- test/cbmc/include/cellular_platform.h | 4 ++-- test/unit-test/cellular_platform.h | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox index 206efa77..99937413 100644 --- a/docs/doxygen/pages.dox +++ b/docs/doxygen/pages.dox @@ -366,14 +366,14 @@ bool PlatformMutex_TryLock( PlatformMutex_t * pMutex ); void PlatformMutex_Unlock( PlatformMutex_t * pMutex ); ``` - Memory
The following malloc/free style APIs should be provided in cellular_platform.h.
- The FreeRTOS memory management document can be referenced for these APIs. + The FreeRTOS memory management document can be referenced for these APIs. ``` // Example implementation of FreeRTOS malloc/free #define Platform_Malloc pvPortMalloc #define Platform_Free vPortFree ``` - EventGroup
The following APIs and handle should be provided in cellular_platform.h.
- Please reference FreeRTOS EvengGroup function prototypes. + Please reference FreeRTOS EvengGroup function prototypes. ``` // Example implementation of FreeRTOS EvengGroup #define PlatformEventGroupHandle_t EventGroupHandle_t @@ -387,7 +387,7 @@ void PlatformMutex_Unlock( PlatformMutex_t * pMutex ); #define PlatformEventGroup_WaitBits xEventGroupWaitBits ``` - Queue
The following APIs and handle should be provided in cellular_platform.h.
- Please reference FreeRTOS Queue function prototypes. + Please reference FreeRTOS Queue function prototypes. ``` // Example implementation of FreeRTOS Queue #define PlatformQueueHandle_t QueueHandle_t @@ -397,7 +397,7 @@ void PlatformMutex_Unlock( PlatformMutex_t * pMutex ); #define PlatformQueue_Delete vQueueDelete ``` - Delay
The following API should be provided in cellular_platform.h.
- Please reference FreeRTOS Task Control function prototypes. + Please reference FreeRTOS Task Control function prototypes. ``` // Example implementation of FreeRTOS Task Control #define Platform_Delay( delayMs ) vTaskDelay( pdMS_TO_TICKS( delayMs ) ) diff --git a/test/cbmc/include/cellular_platform.h b/test/cbmc/include/cellular_platform.h index cb3488bd..e02aec9e 100644 --- a/test/cbmc/include/cellular_platform.h +++ b/test/cbmc/include/cellular_platform.h @@ -41,7 +41,7 @@ * Cellular library use platform event group for process synchronization. * * The EventGroup functions in the following link can be referenced as function prototype. - * https://www.freertos.org/event-groups-API.html + * https://freertos.org/Documentation/02-Kernel/04-API-references/12-Event-groups-or-flags/00-Event-groups * */ @@ -236,7 +236,7 @@ uint16_t PlatformEventGroup_GetBits( PlatformEventGroupHandle_t groupEvent ); * * Cellular library use platform memory allocation APIs to allocate memory dynamically. * The FreeRTOS memory management document can be referenced for these APIs. - * https://www.freertos.org/a00111.html + * https://freertos.org/Documentation/02-Kernel/02-Kernel-features/09-Memory-management/01-Memory-management * */ diff --git a/test/unit-test/cellular_platform.h b/test/unit-test/cellular_platform.h index 60fb7678..8cc5d4ec 100644 --- a/test/unit-test/cellular_platform.h +++ b/test/unit-test/cellular_platform.h @@ -78,7 +78,7 @@ * * Cellular library use platform memory allocation APIs to allocate memory dynamically. * The FreeRTOS memory management document can be referenced for these APIs. - * https://www.freertos.org/a00111.html + * https://freertos.org/Documentation/02-Kernel/02-Kernel-features/09-Memory-management/01-Memory-management * */ @@ -205,7 +205,7 @@ bool Platform_CreateDetachedThread( void ( * threadRoutine )( void * pArgument ) * Cellular library use platform event group for process synchronization. * * The EventGroup functions in the following link can be referenced as function prototype. - * https://www.freertos.org/event-groups-API.html + * https://freertos.org/Documentation/02-Kernel/04-API-references/12-Event-groups-or-flags/00-Event-groups * */ bool PlatformMutex_Create( PlatformMutex_t * pNewMutex,