diff options
Diffstat (limited to 'FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator/Common/cellular_platform.h')
| -rw-r--r-- | FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator/Common/cellular_platform.h | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator/Common/cellular_platform.h b/FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator/Common/cellular_platform.h new file mode 100644 index 000000000..76ad7b1c0 --- /dev/null +++ b/FreeRTOS-Plus/Demo/FreeRTOS_Cellular_Interface_Windows_Simulator/Common/cellular_platform.h @@ -0,0 +1,169 @@ +/* + * FreeRTOS V202107.00 + * Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. + * + * 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://www.FreeRTOS.org + * https://github.com/FreeRTOS + */ + +#ifndef __CELLULAR_PLATFORM_H__ +#define __CELLULAR_PLATFORM_H__ + +#include "FreeRTOS.h" +#include "queue.h" +#include "semphr.h" +#include "event_groups.h" + +#include <stdint.h> +#include <stdbool.h> + +/*-----------------------------------------------------------*/ + +/** + * @brief Cellular library log configuration. + * + * Cellular library use CellularLogLevel macro for logging. + * The prototye of these logging function is similar with printf with return type ignored. + * + */ + +#include "logging_levels.h" +#ifndef LIBRARY_LOG_NAME + #define LIBRARY_LOG_NAME "CELLULAR" +#endif + + +/* Prototype for the function used to print to console on Windows simulator + * of FreeRTOS. + * The function prints to the console before the network is connected; + * then a UDP port after the network has connected. */ +extern void vLoggingPrintf( const char * pcFormatString, + ... ); + +/* Map the SdkLog macro to the logging function to enable logging + * on Windows simulator. */ +#ifndef SdkLog + #define SdkLog( message ) vLoggingPrintf message +#endif + +#ifndef LIBRARY_LOG_LEVEL + #define LIBRARY_LOG_LEVEL LOG_ERROR +#endif +#include "logging_stack.h" + + + +/*-----------------------------------------------------------*/ + +/** + * @brief Cellular library platform thread API and configuration. + * + * Cellular library create a detached thread by this API. + * The threadRoutine should be called with pArgument in the created thread. + * + * PLATFORM_THREAD_DEFAULT_STACK_SIZE and PLATFORM_THREAD_DEFAULT_PRIORITY defines + * the platform related stack size and priority. + */ + +bool Platform_CreateDetachedThread( void ( * threadRoutine )( void * ), + void * pArgument, + int32_t priority, + size_t stackSize ); + +#define PLATFORM_THREAD_DEFAULT_STACK_SIZE ( 2048U ) +#define PLATFORM_THREAD_DEFAULT_PRIORITY ( tskIDLE_PRIORITY + 5U ) + +/*-----------------------------------------------------------*/ + +/** + * @brief Cellular library platform mutex APIs. + * + * Cellular library use platform mutex to protect resource. + * + * The IotMutex_ functions can be referenced as function prototype for + * PlatfromMutex_ prefix function in the following link. + * https://docs.aws.amazon.com/freertos/latest/lib-ref/c-sdk/platform/platform_threads_functions.html + * + */ + +typedef struct PlatformMutex +{ + StaticSemaphore_t xMutex; /**< FreeRTOS mutex. */ + BaseType_t recursive; /**< Type; used for indicating if this is reentrant or normal. */ +} PlatformMutex_t; + +bool PlatformMutex_Create( PlatformMutex_t * pNewMutex, + bool recursive ); +void PlatformMutex_Destroy( PlatformMutex_t * pMutex ); +void PlatformMutex_Lock( PlatformMutex_t * pMutex ); +bool PlatformMutex_TryLock( PlatformMutex_t * pMutex ); +void PlatformMutex_Unlock( PlatformMutex_t * pMutex ); + +/*-----------------------------------------------------------*/ + +/** + * @brief Cellular library platform memory allocation APIs. + * + * 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 + * + */ + +#define Platform_Malloc pvPortMalloc +#define Platform_Free vPortFree + +/*-----------------------------------------------------------*/ + +/** + * @brief Cellular library platform event group APIs. + * + * 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 + * + */ + +#define PlatformEventGroupHandle_t EventGroupHandle_t +#define PlatformEventGroup_Delete vEventGroupDelete +#define PlatformEventGroup_ClearBits xEventGroupClearBits +#define PlatformEventGroup_Create xEventGroupCreate +#define PlatformEventGroup_GetBits xEventGroupGetBits +#define PlatformEventGroup_SetBits xEventGroupSetBits +#define PlatformEventGroup_SetBitsFromISR xEventGroupSetBitsFromISR +#define PlatformEventGroup_WaitBits xEventGroupWaitBits +#define PlatformEventGroup_EventBits EventBits_t +#define PlatformTickType TickType_t + +/*-----------------------------------------------------------*/ + +/** + * @brief Cellular library platform delay function. + * + * Cellular library use platform delay function for waiting events. + * + * The delay functions in the following link can be referenced as function prototype. + * https://www.freertos.org/a00127.html + * + */ +#define Platform_Delay( delayMs ) vTaskDelay( pdMS_TO_TICKS( delayMs ) ) + +#endif /* __CELLULAR_PLATFORM_H__ */ |