application: Move logging macros from .h to .c

urutva · urutva · commit 15fb2d2dc7f0 · 2025-01-06T10:14:00.000Z
Due to incorrect order to libraries during linking stage, which was
caused by `coremqtt-config` interface linking to `helpers-logging` build
was failing. Therefore, move the logging macros definition from `.h` to
`.c`.

Signed-off-by: Devaraj Ranganna &lt;devaraj.ranganna@arm.com&gt;
diff --git a/applications/helpers/ota_orchestrator/CMakeLists.txt b/applications/helpers/ota_orchestrator/CMakeLists.txt
@@ -18,6 +18,7 @@ else()
     )
 
     target_link_libraries(ota-update
+    PUBLIC
         jobs-for-aws-iot-embedded-sdk
         aws-iot-core-mqtt-file-streams-embedded-c
         freertos_kernel
@@ -29,5 +30,7 @@ else()
         helpers-events
         backoff-algorithm
         crt-helpers
+    PRIVATE
+        helpers-logging
     )
 endif()
diff --git a/applications/helpers/ota_orchestrator/src/mqtt_helpers.c b/applications/helpers/ota_orchestrator/src/mqtt_helpers.c
@@ -14,6 +14,18 @@
 #include "ota_register_callback.h"
 #include "ota_types_definitions.h"
 
+/* Include header that defines log levels. */
+#include "logging_levels.h"
+
+/* Configure name and log level for the OTA library. */
+#ifndef LIBRARY_LOG_NAME
+    #define LIBRARY_LOG_NAME     "OTA"
+#endif
+#ifndef LIBRARY_LOG_LEVEL
+    #define LIBRARY_LOG_LEVEL    LOG_INFO
+#endif
+#include "logging_stack.h"
+
 /* Provides external linkage only when running unit test */
 #ifdef UNIT_TESTING
     #define STATIC    /* as nothing */
diff --git a/applications/helpers/ota_orchestrator/src/ota_orchestrator.c b/applications/helpers/ota_orchestrator/src/ota_orchestrator.c
@@ -68,6 +68,18 @@
 #include "ota_register_callback.h"
 #include "ota_types_definitions.h"
 
+/* Include header that defines log levels. */
+#include "logging_levels.h"
+
+/* Configure name and log level for the OTA library. */
+#ifndef LIBRARY_LOG_NAME
+    #define LIBRARY_LOG_NAME     "OTA"
+#endif
+#ifndef LIBRARY_LOG_LEVEL
+    #define LIBRARY_LOG_LEVEL    LOG_INFO
+#endif
+#include "logging_stack.h"
+
 #define NUM_OF_BLOCKS_REQUESTED    1U
 #define START_JOB_MSG_LENGTH       147U
 #define MAX_JOB_ID_LENGTH          64U
diff --git a/applications/helpers/ota_orchestrator/src/ota_os_freertos.c b/applications/helpers/ota_orchestrator/src/ota_os_freertos.c
@@ -28,6 +28,18 @@
 
 #include "ota_types_definitions.h"
 
+/* Include header that defines log levels. */
+#include "logging_levels.h"
+
+/* Configure name and log level for the OTA library. */
+#ifndef LIBRARY_LOG_NAME
+    #define LIBRARY_LOG_NAME     "OTA"
+#endif
+#ifndef LIBRARY_LOG_LEVEL
+    #define LIBRARY_LOG_LEVEL    LOG_INFO
+#endif
+#include "logging_stack.h"
+
 /* OTA Event queue attributes.*/
 #define MAX_MESSAGES    20
 #define MAX_MSG_SIZE    sizeof( OtaEventMsg_t )
diff --git a/applications/helpers/sntp/CMakeLists.txt b/applications/helpers/sntp/CMakeLists.txt
@@ -20,11 +20,13 @@ else()
     )
 
     target_link_libraries(helpers-sntp
+    PUBLIC
         backoff-algorithm
         connectivity-stack
         corepkcs11
         coresntp
-        helpers-logging
         mbedtls
+    PRIVATE
+        helpers-logging
     )
 endif()
diff --git a/applications/keyword_detection/CMakeLists.txt b/applications/keyword_detection/CMakeLists.txt
@@ -141,6 +141,7 @@ target_link_libraries(keyword-detection
         fri-bsp
         helpers-device-advisor
         helpers-events
+        helpers-logging
         mbedtls
         ota-update
         provisioning-lib
diff --git a/applications/keyword_detection/configs/aws_configs/CMakeLists.txt b/applications/keyword_detection/configs/aws_configs/CMakeLists.txt
@@ -7,11 +7,6 @@ target_include_directories(coremqtt-config
         .
 )
 
-target_link_libraries(coremqtt-config
-    INTERFACE
-        helpers-logging
-)
-
 target_compile_definitions(coremqtt-agent-config
     INTERFACE
         MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG
diff --git a/applications/keyword_detection/configs/aws_configs/core_mqtt_config.h b/applications/keyword_detection/configs/aws_configs/core_mqtt_config.h
@@ -25,19 +25,6 @@
 #ifndef CORE_MQTT_CONFIG_H
 #define CORE_MQTT_CONFIG_H
 
-#include "logging_levels.h"
-
-/* Logging configuration for the MQTT library. */
-#ifndef LIBRARY_LOG_NAME
-    #define LIBRARY_LOG_NAME    "MQTT"
-#endif
-
-#ifndef LIBRARY_LOG_LEVEL
-    #define LIBRARY_LOG_LEVEL    LOG_INFO
-#endif
-
-#include "logging_stack.h"
-
 /**
  * @brief The maximum number of MQTT PUBLISH messages that may be pending
  * acknowledgment at any time.
diff --git a/applications/keyword_detection/configs/aws_configs/ota_config.h b/applications/keyword_detection/configs/aws_configs/ota_config.h
@@ -28,30 +28,6 @@
 #ifndef OTA_CONFIG_H_
 #define OTA_CONFIG_H_
 
-/**************************************************/
-/******* DO NOT CHANGE the following order ********/
-/**************************************************/
-
-/* Logging related header files are required to be included in the following order:
- * 1. Include the header file "logging_levels.h".
- * 2. Define LIBRARY_LOG_NAME and  LIBRARY_LOG_LEVEL.
- * 3. Include the header file "logging_stack.h".
- */
-
-/* Include header that defines log levels. */
-#include "logging_levels.h"
-
-/* Configure name and log level for the OTA library. */
-#ifndef LIBRARY_LOG_NAME
-    #define LIBRARY_LOG_NAME     "OTA"
-#endif
-#ifndef LIBRARY_LOG_LEVEL
-    #define LIBRARY_LOG_LEVEL    LOG_INFO
-#endif
-#include "logging_stack.h"
-
-/************ End of logging configuration ****************/
-
 /* Include config file used for testing the OTA PAL. This config file defines
  * the otapalconfigCODE_SIGNING_CERTIFICATE macro. */
 #include "ota_demo_config.h"
diff --git a/applications/keyword_detection/main.c b/applications/keyword_detection/main.c
@@ -30,6 +30,18 @@
 
 #include "FreeRTOSConfig.h"
 
+/* Include header that defines log levels. */
+#include "logging_levels.h"
+
+/* Configure name and log level for the OTA library. */
+#ifndef LIBRARY_LOG_NAME
+    #define LIBRARY_LOG_NAME     "main"
+#endif
+#ifndef LIBRARY_LOG_LEVEL
+    #define LIBRARY_LOG_LEVEL    LOG_INFO
+#endif
+#include "logging_stack.h"
+
 #ifdef AUDIO_VSI
     #include "Driver_SAI.h"
 #endif
diff --git a/applications/object_detection/CMakeLists.txt b/applications/object_detection/CMakeLists.txt
@@ -134,6 +134,7 @@ target_link_libraries(object-detection
         toolchain-override
         object_detection_api
         object_detection_model
+        helpers-logging
 )
 
 include(${IOT_REFERENCE_ARM_CORSTONE3XX_SOURCE_DIR}/bsp/cmake/SetLinkerOptions.cmake)
diff --git a/applications/object_detection/configs/aws_configs/CMakeLists.txt b/applications/object_detection/configs/aws_configs/CMakeLists.txt
@@ -7,11 +7,6 @@ target_include_directories(coremqtt-config
         .
 )
 
-target_link_libraries(coremqtt-config
-    INTERFACE
-        helpers-logging
-)
-
 target_compile_definitions(coremqtt-agent-config
     INTERFACE
         MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG
diff --git a/applications/object_detection/configs/aws_configs/core_mqtt_config.h b/applications/object_detection/configs/aws_configs/core_mqtt_config.h
@@ -25,19 +25,6 @@
 #ifndef CORE_MQTT_CONFIG_H
 #define CORE_MQTT_CONFIG_H
 
-#include "logging_levels.h"
-
-/* Logging configuration for the MQTT library. */
-#ifndef LIBRARY_LOG_NAME
-    #define LIBRARY_LOG_NAME    "MQTT"
-#endif
-
-#ifndef LIBRARY_LOG_LEVEL
-    #define LIBRARY_LOG_LEVEL    LOG_INFO
-#endif
-
-#include "logging_stack.h"
-
 /**
  * @brief The maximum number of MQTT PUBLISH messages that may be pending
  * acknowledgment at any time.
diff --git a/applications/object_detection/isp/CMakeLists.txt b/applications/object_detection/isp/CMakeLists.txt
@@ -19,5 +19,4 @@ target_sources(isp-config
 target_link_libraries(isp-config
     INTERFACE
         isp_control
-        helpers-logging
 )
diff --git a/applications/object_detection/main.c b/applications/object_detection/main.c
@@ -28,6 +28,22 @@
 
 #include "FreeRTOSConfig.h"
 
+/* Include header that defines log levels. */
+#include "logging_levels.h"
+
+/* Configure name and log level for the OTA library. */
+#ifndef LIBRARY_LOG_NAME
+    #define LIBRARY_LOG_NAME     "main"
+#endif
+#ifndef LIBRARY_LOG_LEVEL
+    #define LIBRARY_LOG_LEVEL    LOG_INFO
+#endif
+#include "logging_stack.h"
+
+#ifdef AUDIO_VSI
+    #include "Driver_SAI.h"
+#endif
+
 #ifdef AUDIO_VSI
     #include "Driver_SAI.h"
 #endif
diff --git a/applications/speech_recognition/CMakeLists.txt b/applications/speech_recognition/CMakeLists.txt
@@ -161,6 +161,7 @@ target_link_libraries(speech-recognition
         toolchain-override
         asr_api
         asr_model
+        helpers-logging
 )
 
 include(${IOT_REFERENCE_ARM_CORSTONE3XX_SOURCE_DIR}/bsp/cmake/SetLinkerOptions.cmake)
diff --git a/applications/speech_recognition/configs/aws_configs/CMakeLists.txt b/applications/speech_recognition/configs/aws_configs/CMakeLists.txt
@@ -7,11 +7,6 @@ target_include_directories(coremqtt-config
         .
 )
 
-target_link_libraries(coremqtt-config
-    INTERFACE
-        helpers-logging
-)
-
 target_compile_definitions(coremqtt-agent-config
     INTERFACE
         MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG
diff --git a/applications/speech_recognition/configs/aws_configs/core_mqtt_config.h b/applications/speech_recognition/configs/aws_configs/core_mqtt_config.h
@@ -25,19 +25,6 @@
 #ifndef CORE_MQTT_CONFIG_H
 #define CORE_MQTT_CONFIG_H
 
-#include "logging_levels.h"
-
-/* Logging configuration for the MQTT library. */
-#ifndef LIBRARY_LOG_NAME
-    #define LIBRARY_LOG_NAME    "MQTT"
-#endif
-
-#ifndef LIBRARY_LOG_LEVEL
-    #define LIBRARY_LOG_LEVEL    LOG_INFO
-#endif
-
-#include "logging_stack.h"
-
 /**
  * @brief The maximum number of MQTT PUBLISH messages that may be pending
  * acknowledgment at any time.
diff --git a/applications/speech_recognition/main.c b/applications/speech_recognition/main.c
@@ -32,6 +32,18 @@
 
 #include "FreeRTOSConfig.h"
 
+/* Include header that defines log levels. */
+#include "logging_levels.h"
+
+/* Configure name and log level for the OTA library. */
+#ifndef LIBRARY_LOG_NAME
+    #define LIBRARY_LOG_NAME     "main"
+#endif
+#ifndef LIBRARY_LOG_LEVEL
+    #define LIBRARY_LOG_LEVEL    LOG_INFO
+#endif
+#include "logging_stack.h"
+
 #ifdef AUDIO_VSI
     #include "Driver_SAI.h"
 #endif
diff --git a/components/connectivity/freertos_plus_tcp/integration/CMakeLists.txt b/components/connectivity/freertos_plus_tcp/integration/CMakeLists.txt
@@ -27,6 +27,7 @@ else ()
         PRIVATE
             coremqtt
             helpers-events
+            helpers-logging
             iot-tls
     )
 
diff --git a/components/connectivity/iot_vsocket/integration/CMakeLists.txt b/components/connectivity/iot_vsocket/integration/CMakeLists.txt
@@ -22,6 +22,7 @@ else()
         PRIVATE
             coremqtt
             helpers-events
+            helpers-logging
             fri-bsp
             iot-socket-api
             iot-tls
diff --git a/release_changes/202412161811.change.md b/release_changes/202412161811.change.md
@@ -0,0 +1 @@
+Update AWS libraries to `202406.01-LTS`

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ else()`
`18`	`18`	`)`
`19`	`19`
`20`	`20`	`target_link_libraries(ota-update`
	`21`	`+ PUBLIC`
`21`	`22`	`jobs-for-aws-iot-embedded-sdk`
`22`	`23`	`aws-iot-core-mqtt-file-streams-embedded-c`
`23`	`24`	`freertos_kernel`
`@@ -29,5 +30,7 @@ else()`
`29`	`30`	`helpers-events`
`30`	`31`	`backoff-algorithm`
`31`	`32`	`crt-helpers`
	`33`	`+ PRIVATE`
	`34`	`+ helpers-logging`
`32`	`35`	`)`
`33`	`36`	`endif()`
Original file line number	Diff line number	Diff line change
`@@ -20,11 +20,13 @@ else()`
`20`	`20`	`)`
`21`	`21`
`22`	`22`	`target_link_libraries(helpers-sntp`
	`23`	`+ PUBLIC`
`23`	`24`	`backoff-algorithm`
`24`	`25`	`connectivity-stack`
`25`	`26`	`corepkcs11`
`26`	`27`	`coresntp`
`27`		`- helpers-logging`
`28`	`28`	`mbedtls`
	`29`	`+ PRIVATE`
	`30`	`+ helpers-logging`
`29`	`31`	`)`
`30`	`32`	`endif()`
Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,6 @@ target_include_directories(coremqtt-config`
`7`	`7`	`.`
`8`	`8`	`)`
`9`	`9`
`10`		`-target_link_libraries(coremqtt-config`
`11`		`- INTERFACE`
`12`		`- helpers-logging`
`13`		`-)`
`14`		`-`
`15`	`10`	`target_compile_definitions(coremqtt-agent-config`
`16`	`11`	`INTERFACE`
`17`	`12`	`MQTT_AGENT_DO_NOT_USE_CUSTOM_CONFIG`