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>
This commit is contained in:
Ioannis Glaropoulos 2018-06-28 23:16:17 +02:00 committed by Kumar Gala
commit 7c9a1f0f76
8 changed files with 36 additions and 0 deletions

View file

@ -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"

View file

@ -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 */

View file

@ -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 */

View file

@ -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 */

View file

@ -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>

View file

@ -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

View file

@ -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

View file

@ -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