aarch32: Add header shims to support old file locations

Out-of-tree code can still be using the old file locations. Introduce
header shims to include the headers from the new correct location and
print a warning message.

Add also a new Kconfig symbol to suppress such warning.

The shim will go away after two releases, so make sure to adapt your
application for the new locations.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>

Kconfig.zephyr

@@ -413,3 +413,14 @@ config MISRA_SANE
 	  arrays are not permitted (and gcc will enforce this).
 
 endmenu
+
+menu "Compatibility"
+
+config COMPAT_INCLUDES
+	bool "Suppress warnings when using header shims"
+	default y
+	help
+	  Suppress any warnings from the pre-processor when including
+	  deprecated header files.
+
+endmenu

arch/arm/include/cortex_m/cmse.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_CMSE_H_
+#define ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_CMSE_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <aarch32/cortex_m/cmse.h> instead."
+#endif
+
+#include <aarch32/cortex_m/cmse.h>
+
+#endif /* ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_CMSE_H_ */

arch/arm/include/cortex_m/exc.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_EXC_H_
+#define ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_EXC_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <aarch32/cortex_m/exc.h> instead."
+#endif
+
+#include <aarch32/cortex_m/exc.h>
+
+#endif /* ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_EXC_H_ */

arch/arm/include/cortex_m/stack.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_STACK_H_
+#define ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_STACK_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <aarch32/cortex_m/stack.h> instead."
+#endif
+
+#include <aarch32/cortex_m/stack.h>
+
+#endif /* ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_STACK_H_ */

arch/arm/include/cortex_m/tz.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_TZ_H_
+#define ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_TZ_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <aarch32/cortex_m/tz.h> instead."
+#endif
+
+#include <aarch32/cortex_m/tz.h>
+
+#endif /* ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_M_TZ_H_ */

arch/arm/include/cortex_r/exc.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_R_EXC_H_
+#define ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_R_EXC_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <aarch32/cortex_r/exc.h> instead."
+#endif
+
+#include <aarch32/cortex_r/exc.h>
+
+#endif /* ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_R_EXC_H_ */

arch/arm/include/cortex_r/stack.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_R_STACK_H_
+#define ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_R_STACK_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <aarch32/cortex_r/stack.h> instead."
+#endif
+
+#include <aarch32/cortex_r/stack.h>
+
+#endif /* ZEPHYR_ARCH_ARM_INCLUDE_CORTEX_R_STACK_H_ */

include/arch/arm/arch.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_ARCH_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_ARCH_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/arch.h> instead."
+#endif
+
+#include <arch/arm/aarch32/arch.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_ARCH_H_ */

include/arch/arm/asm_inline.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_ASM_INLINE_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_ASM_INLINE_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/asm_inline.h> instead."
+#endif
+
+#include <arch/arm/aarch32/asm_inline.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_ASM_INLINE_H_ */

include/arch/arm/asm_inline_gcc.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_ASM_INLINE_GCC_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_ASM_INLINE_GCC_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/asm_inline_gcc.h> instead."
+#endif
+
+#include <arch/arm/aarch32/asm_inline_gcc.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_ASM_INLINE_GCC_H_ */

include/arch/arm/cortex_m/cmsis.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_CMSIS_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_CMSIS_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_m/cmsis.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_m/cmsis.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_CMSIS_H_ */

include/arch/arm/cortex_m/cpu.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_CPU_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_CPU_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_m/cpu.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_m/cpu.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_CPU_H_ */

include/arch/arm/cortex_m/memory_map.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MEMORY_MAP_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MEMORY_MAP_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_m/memory_map.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_m/memory_map.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MEMORY_MAP_H_ */

include/arch/arm/cortex_m/mpu/arm_mpu.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_m/mpu/arm_mpu.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_m/mpu/arm_mpu.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_H_ */

include/arch/arm/cortex_m/mpu/arm_mpu_v7m.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_V7M_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_V7M_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_m/mpu/arm_mpu_v7m.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_m/mpu/arm_mpu_v7m.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_V7M_H_ */

include/arch/arm/cortex_m/mpu/arm_mpu_v8m.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_V8M_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_V8M_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_m/mpu/arm_mpu_v8m.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_m/mpu/arm_mpu_v8m.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_ARM_MPU_V8M_H_ */

include/arch/arm/cortex_m/mpu/nxp_mpu.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_NXP_MPU_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_NXP_MPU_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_m/mpu/nxp_mpu.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_m/mpu/nxp_mpu.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_M_MPU_NXP_MPU_H_ */

include/arch/arm/cortex_m/scripts/linker.ld

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <arch/arm/aarch32/cortex_m/scripts/linker.ld>

include/arch/arm/cortex_r/cpu.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_R_CPU_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_R_CPU_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_r/cpu.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_r/cpu.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_R_CPU_H_ */

include/arch/arm/cortex_r/scripts/app_data_alignment.ld

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2017 Linaro Limited.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/* Set initial alignment to the 32 byte minimum for all MPUs */
+_app_data_align = 32;
+. = ALIGN(32);

include/arch/arm/cortex_r/scripts/linker.ld

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <arch/arm/aarch32/cortex_r/scripts/linker.ld>

include/arch/arm/cortex_r/sys_io.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_R_SYS_IO_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_R_SYS_IO_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/cortex_r/sys_io.h> instead."
+#endif
+
+#include <arch/arm/aarch32/cortex_r/sys_io.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_CORTEX_R_SYS_IO_H_ */

include/arch/arm/error.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_ERROR_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_ERROR_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/error.h> instead."
+#endif
+
+#include <arch/arm/aarch32/error.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_ERROR_H_ */

include/arch/arm/exc.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_EXC_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_EXC_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/exc.h> instead."
+#endif
+
+#include <arch/arm/aarch32/exc.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_EXC_H_ */

include/arch/arm/irq.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_IRQ_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_IRQ_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/irq.h> instead."
+#endif
+
+#include <arch/arm/aarch32/irq.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_IRQ_H_ */

include/arch/arm/misc.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_MISC_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_MISC_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/misc.h> instead."
+#endif
+
+#include <arch/arm/aarch32/misc.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_MISC_H_ */

include/arch/arm/nmi.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_NMI_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_NMI_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/nmi.h> instead."
+#endif
+
+#include <arch/arm/aarch32/nmi.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_NMI_H_ */

include/arch/arm/syscall.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_SYSCALL_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_SYSCALL_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/syscall.h> instead."
+#endif
+
+#include <arch/arm/aarch32/syscall.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_SYSCALL_H_ */

include/arch/arm/thread.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2019 Carlo Caione <ccaione@baylibre.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_ARCH_ARM_THREAD_H_
+#define ZEPHYR_INCLUDE_ARCH_ARM_THREAD_H_
+
+#ifndef CONFIG_COMPAT_INCLUDES
+#warning "This header file has moved, include <arch/arm/aarch32/thread.h> instead."
+#endif
+
+#include <arch/arm/aarch32/thread.h>
+
+#endif /* ZEPHYR_INCLUDE_ARCH_ARM_THREAD_H_ */