Skip to content

Commit

Permalink
Fix freertos.org link in the source and doxygen files
Browse files Browse the repository at this point in the history
  • Loading branch information
chinglee-iot committed Aug 9, 2024
1 parent ed26e0b commit 81ec5b4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/doxygen/pages.dox
Original file line number Diff line number Diff line change
Expand Up @@ -366,14 +366,14 @@ bool PlatformMutex_TryLock( PlatformMutex_t * pMutex );
void PlatformMutex_Unlock( PlatformMutex_t * pMutex );
```
- <b>Memory</b><br>The following malloc/free style APIs should be provided in cellular_platform.h.<br>
The <a href="https://www.freertos.org/a00111.html">FreeRTOS memory management document</a> can be referenced for these APIs.
The <a href="https://freertos.org/Documentation/02-Kernel/02-Kernel-features/09-Memory-management/01-Memory-management">FreeRTOS memory management document</a> can be referenced for these APIs.
```
// Example implementation of FreeRTOS malloc/free
#define Platform_Malloc pvPortMalloc
#define Platform_Free vPortFree
```
- <b>EventGroup</b><br>The following APIs and handle should be provided in cellular_platform.h.<br>
Please reference <a href="https://www.freertos.org/event-groups-API.html">FreeRTOS EvengGroup function prototypes</a>.
Please reference <a href="https://freertos.org/Documentation/02-Kernel/04-API-references/12-Event-groups-or-flags/00-Event-groups">FreeRTOS EvengGroup function prototypes</a>.
```
// Example implementation of FreeRTOS EvengGroup
#define PlatformEventGroupHandle_t EventGroupHandle_t
Expand All @@ -387,7 +387,7 @@ void PlatformMutex_Unlock( PlatformMutex_t * pMutex );
#define PlatformEventGroup_WaitBits xEventGroupWaitBits
```
- <b>Queue</b><br>The following APIs and handle should be provided in cellular_platform.h.<br>
Please reference <a href="https://freertos.org/a00018.html">FreeRTOS Queue function prototypes</a>.
Please reference <a href="https://freertos.org/Documentation/02-Kernel/04-API-references/06-Queues/00-QueueManagement">FreeRTOS Queue function prototypes</a>.
```
// Example implementation of FreeRTOS Queue
#define PlatformQueueHandle_t QueueHandle_t
Expand All @@ -397,7 +397,7 @@ void PlatformMutex_Unlock( PlatformMutex_t * pMutex );
#define PlatformQueue_Delete vQueueDelete
```
- <b>Delay</b><br>The following API should be provided in cellular_platform.h.<br>
Please reference <a href="https://www.freertos.org/a00127.html">FreeRTOS Task Control function prototypes</a>.
Please reference <a href="https://freertos.org/Documentation/02-Kernel/04-API-references/02-Task-control/00-Task-control">FreeRTOS Task Control function prototypes</a>.
```
// Example implementation of FreeRTOS Task Control
#define Platform_Delay( delayMs ) vTaskDelay( pdMS_TO_TICKS( delayMs ) )
Expand Down
4 changes: 2 additions & 2 deletions test/cbmc/include/cellular_platform.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
*/

Expand Down Expand Up @@ -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
*
*/

Expand Down
4 changes: 2 additions & 2 deletions test/unit-test/cellular_platform.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
*/

Expand Down Expand Up @@ -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,
Expand Down

0 comments on commit 81ec5b4

Please sign in to comment.