Update coding style and comments

Update coding style and comments

Author: chinglee-iot

source/MutualAuthMQTTExample.c

@@ -146,7 +146,7 @@
 
 /**
  * @brief Time in ticks to wait between each cycle of the demo implemented
- * by prvMQTTDemoTask().
+ * by RunMQTTTask().
  */
 #define mqttexampleDELAY_BETWEEN_DEMO_ITERATIONS_TICKS    ( pdMS_TO_TICKS( 5000U ) )
 
@@ -256,7 +256,7 @@
  * @param[in] pvParameters Parameters as passed at the time of task creation. Not
  * used in this example.
  */
-void MQTTDemoTask( void * pvParameters );
+void RunMQTTTask( void * pvParameters );
 
 /**
  * @brief Connect to MQTT broker with reconnection retries.
@@ -427,7 +427,7 @@ static MQTTFixedBuffer_t xBuffer =
  * subscribed to, so it will expect all the messages it sends to the broker to be
  * sent back to it from the broker.
  */
-void MQTTDemoTask( void * pvParameters )
+void RunMQTTTask( void * pvParameters )
 {
     uint32_t ulPublishCount = 0U, ulTopicCount = 0U;
     const uint32_t ulMaxPublishCount = 5UL;
@@ -522,7 +522,7 @@ void MQTTDemoTask( void * pvParameters )
 
         /* Wait for some time between two iterations to ensure that we do not
          * bombard the broker. */
-        LogInfo( ( "prvMQTTDemoTask() completed an iteration successfully. "
+        LogInfo( ( "RunMQTTTask() completed an iteration successfully. "
                    "Total free heap is %u.\r\n",
                    xPortGetFreeHeapSize() ) );
         LogInfo( ( "Demo completed successfully.\r\n" ) );

source/cellular/bg96/cellular_config.h

@@ -37,7 +37,7 @@
 /**
  * Cellular comm interface make use of COM port on computer to communicate with
  * cellular module on windows simulator, for example "COM5".
- * #define CELLULAR_COMM_INTERFACE_PORT                   "...insert here..."
+ * #define CELLULAR_COMM_INTERFACE_PORT    "...insert here..."
  */
 
 /*

source/cellular/cellular_platform.c

@@ -51,7 +51,7 @@ static void prvThreadRoutineWrapper( void * pArgument );
  * @brief Lock mutex with timeout.
  *
  * @param[in] pMutex Mutex to lock.
- * @param[in] timeout timeout value to lock mutex.
+ * @param[in] timeout Timeout value to lock mutex.
  *
  * @return ture if mutex is locked successfully. Otherwise false.
  */
@@ -76,7 +76,7 @@ static void prvThreadRoutineWrapper( void * pArgument )
 static bool prIotMutexTimedLock( PlatformMutex_t * pMutex,
                                  TickType_t timeout )
 {
-    BaseType_t lockResult;
+    BaseType_t lockResult = pdTRUE;
 
     configASSERT( pMutex != NULL );
 
@@ -103,11 +103,13 @@ bool Platform_CreateDetachedThread( void ( *threadRoutine )( void * ),
                                     size_t stackSize )
 {
     bool status = true;
+    threadInfo_t * pThreadInfo = NULL;
 
     configASSERT( threadRoutine != NULL );
 
     CellularLogDebug( "Creating new thread." );
-    threadInfo_t * pThreadInfo = Platform_Malloc( sizeof( threadInfo_t ) );
+
+    pThreadInfo = Platform_Malloc( sizeof( threadInfo_t ) );
 
     if( pThreadInfo == NULL )
     {
@@ -116,7 +118,7 @@ bool Platform_CreateDetachedThread( void ( *threadRoutine )( void * ),
     }
 
     /* Create the FreeRTOS task that will run the thread. */
-    if( status )
+    if( status == true )
     {
         pThreadInfo->threadRoutine = threadRoutine;
         pThreadInfo->pArgument = pArgument;
@@ -133,6 +135,10 @@ bool Platform_CreateDetachedThread( void ( *threadRoutine )( void * ),
             Platform_Free( pThreadInfo );
             status = false;
         }
+        else
+        {
+            CellularLogDebug( "New thread created." );
+        }
     }
 
     return status;
@@ -143,21 +149,24 @@ bool Platform_CreateDetachedThread( void ( *threadRoutine )( void * ),
 bool PlatformMutex_Create( PlatformMutex_t * pNewMutex,
                            bool recursive )
 {
+    SemaphoreHandle_t xSemaphore = NULL;
+    bool retMutexCreate = false;
+
     configASSERT( pNewMutex != NULL );
 
     CellularLogDebug( "Creating new mutex %p.", pNewMutex );
 
-    if( recursive )
+    if( recursive == true )
     {
-        ( void ) xSemaphoreCreateRecursiveMutexStatic( &pNewMutex->xMutex );
+        xSemaphore = xSemaphoreCreateRecursiveMutexStatic( &pNewMutex->xMutex );
     }
     else
     {
-        ( void ) xSemaphoreCreateMutexStatic( &pNewMutex->xMutex );
+        xSemaphore = xSemaphoreCreateMutexStatic( &pNewMutex->xMutex );
     }
 
-    /* remember the type of mutex */
-    if( recursive )
+    /* Remember the type of mutex. */
+    if( recursive == true )
     {
         pNewMutex->recursive = pdTRUE;
     }
@@ -166,7 +175,17 @@ bool PlatformMutex_Create( PlatformMutex_t * pNewMutex,
         pNewMutex->recursive = pdFALSE;
     }
 
-    return true;
+    /* Check the handle value returned by the mutex create function. */
+    if( xSemaphore == NULL )
+    {
+        retMutexCreate = false;
+    }
+    else
+    {
+        retMutexCreate = true;
+    }
+
+    return retMutexCreate;
 }
 
 /*-----------------------------------------------------------*/

source/cellular/cellular_platform.h

@@ -76,7 +76,7 @@ bool Platform_CreateDetachedThread( void ( * threadRoutine )( void * ),
                                     size_t stackSize );
 
 #define PLATFORM_THREAD_DEFAULT_STACK_SIZE    ( 2048U )
-#define PLATFORM_THREAD_DEFAULT_PRIORITY      ( 5U )
+#define PLATFORM_THREAD_DEFAULT_PRIORITY      ( tskIDLE_PRIORITY + 5U )
 
 /*-----------------------------------------------------------*/
 
@@ -85,7 +85,8 @@ bool Platform_CreateDetachedThread( void ( * threadRoutine )( void * ),
  *
  * Cellular library use platform mutex to protect resource.
  *
- * The IotMutex_ functions can be refernced as function prototype.
+ * The IotMutex_ functions can be refernced 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
  *
  */