From 7c9a1f0f76ecca4974a9554c5c03d56dc8061a23 Mon Sep 17 00:00:00 2001
From: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
Date: Thu, 28 Jun 2018 23:16:17 +0200
Subject: [PATCH] arch: arm: soc: add explanatory comment for kernel headers'
 inclusion

This commit adds an explanatory comment in all soc.h headers,
where kernel_includes.h header has been included, to stress out
that this header must be included after SOC-specific headers are
brought in. The reason is the fact that kernel_includes.h needs
the ARM CMSIS definitions, which are brought in by the
SOC-specific header inclusions.

Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
---
 arch/arm/soc/arm/beetle/soc.h       | 4 ++++
 arch/arm/soc/atmel_sam/same70/soc.h | 4 ++++
 arch/arm/soc/nordic_nrf/nrf51/soc.h | 5 +++++
 arch/arm/soc/nordic_nrf/nrf52/soc.h | 5 +++++
 arch/arm/soc/nxp_imx/rt/soc.h       | 5 +++++
 arch/arm/soc/st_stm32/stm32f4/soc.h | 4 ++++
 arch/arm/soc/st_stm32/stm32f7/soc.h | 4 ++++
 arch/arm/soc/st_stm32/stm32l4/soc.h | 5 +++++
 8 files changed, 36 insertions(+)

diff --git a/arch/arm/soc/arm/beetle/soc.h b/arch/arm/soc/arm/beetle/soc.h
index 49e162c9893..0fbea5bcbcb 100644
--- a/arch/arm/soc/arm/beetle/soc.h
+++ b/arch/arm/soc/arm/beetle/soc.h
@@ -89,6 +89,10 @@
 
 #ifndef _ASMLANGUAGE
 
+/* ARM CMSIS definitions must be included before kernel_includes.h.
+ * Therefore, it is essential to include kernel_includes.h after including
+ * core SOC-specific headers.
+ */
 #include <kernel_includes.h>
 
 #include "soc_pins.h"
diff --git a/arch/arm/soc/atmel_sam/same70/soc.h b/arch/arm/soc/atmel_sam/same70/soc.h
index 38956644022..007e4a1e8cb 100644
--- a/arch/arm/soc/atmel_sam/same70/soc.h
+++ b/arch/arm/soc/atmel_sam/same70/soc.h
@@ -46,6 +46,10 @@
 #include "../common/soc_pmc.h"
 #include "../common/soc_gpio.h"
 
+/* ARM CMSIS definitions must be included before kernel_includes.h.
+ * Therefore, it is essential to include kernel_includes.h after including
+ * core SOC-specific headers.
+ */
 #include <kernel_includes.h>
 
 #endif /* _ASMLANGUAGE */
diff --git a/arch/arm/soc/nordic_nrf/nrf51/soc.h b/arch/arm/soc/nordic_nrf/nrf51/soc.h
index de1393a6a69..35804f1f6fd 100644
--- a/arch/arm/soc/nordic_nrf/nrf51/soc.h
+++ b/arch/arm/soc/nordic_nrf/nrf51/soc.h
@@ -15,6 +15,11 @@
 
 #include <nrf_common.h>
 #include <nrf.h>
+
+/* ARM CMSIS definitions must be included before kernel_includes.h.
+ * Therefore, it is essential to include kernel_includes.h after including
+ * core SOC-specific headers.
+ */
 #include <kernel_includes.h>
 
 /* Add include for DTS generated information */
diff --git a/arch/arm/soc/nordic_nrf/nrf52/soc.h b/arch/arm/soc/nordic_nrf/nrf52/soc.h
index 880fa39c457..f0ae7711789 100644
--- a/arch/arm/soc/nordic_nrf/nrf52/soc.h
+++ b/arch/arm/soc/nordic_nrf/nrf52/soc.h
@@ -15,6 +15,11 @@
 
 #include <nrf_common.h>
 #include <nrf.h>
+
+/* ARM CMSIS definitions must be included before kernel_includes.h.
+ * Therefore, it is essential to include kernel_includes.h after including
+ * core SOC-specific headers.
+ */
 #include <kernel_includes.h>
 
 /* Add include for DTS generated information */
diff --git a/arch/arm/soc/nxp_imx/rt/soc.h b/arch/arm/soc/nxp_imx/rt/soc.h
index 26ccc919fdb..185503194e8 100644
--- a/arch/arm/soc/nxp_imx/rt/soc.h
+++ b/arch/arm/soc/nxp_imx/rt/soc.h
@@ -16,6 +16,11 @@ extern "C" {
 #ifndef _ASMLANGUAGE
 
 #include <fsl_common.h>
+
+/* ARM CMSIS definitions must be included before kernel_includes.h.
+ * Therefore, it is essential to include kernel_includes.h after including
+ * core SOC-specific headers.
+ */
 #include <kernel_includes.h>
 
 
diff --git a/arch/arm/soc/st_stm32/stm32f4/soc.h b/arch/arm/soc/st_stm32/stm32f4/soc.h
index 044701feee7..4d582dcb92e 100644
--- a/arch/arm/soc/st_stm32/stm32f4/soc.h
+++ b/arch/arm/soc/st_stm32/stm32f4/soc.h
@@ -26,6 +26,10 @@
 
 #include <stm32f4xx.h>
 
+/* ARM CMSIS definitions must be included before kernel_includes.h.
+ * Therefore, it is essential to include kernel_includes.h after including
+ * core SOC-specific headers.
+ */
 #include <kernel_includes.h>
 
 #ifdef CONFIG_CLOCK_CONTROL_STM32_CUBE
diff --git a/arch/arm/soc/st_stm32/stm32f7/soc.h b/arch/arm/soc/st_stm32/stm32f7/soc.h
index e3c67d56761..5ffe692b94a 100644
--- a/arch/arm/soc/st_stm32/stm32f7/soc.h
+++ b/arch/arm/soc/st_stm32/stm32f7/soc.h
@@ -25,6 +25,10 @@
 
 #include <stm32f7xx.h>
 
+/* ARM CMSIS definitions must be included before kernel_includes.h.
+ * Therefore, it is essential to include kernel_includes.h after including
+ * core SOC-specific headers.
+ */
 #include <kernel_includes.h>
 
 #ifdef CONFIG_CLOCK_CONTROL_STM32_CUBE
diff --git a/arch/arm/soc/st_stm32/stm32l4/soc.h b/arch/arm/soc/st_stm32/stm32l4/soc.h
index fafe6725dde..a952560ed9a 100644
--- a/arch/arm/soc/st_stm32/stm32l4/soc.h
+++ b/arch/arm/soc/st_stm32/stm32l4/soc.h
@@ -23,6 +23,11 @@
 
 #include <autoconf.h>
 #include <stm32l4xx.h>
+
+/* ARM CMSIS definitions must be included before kernel_includes.h.
+ * Therefore, it is essential to include kernel_includes.h after including
+ * core SOC-specific headers.
+ */
 #include <kernel_includes.h>
 
 #define GPIO_REG_SIZE         0x400