Sanitise includes across codebase

Enforce full include path for includes. Deprecate old paths.

The following folders inside include/lib have been left unchanged:

- include/lib/cpus/${ARCH}
- include/lib/el3_runtime/${ARCH}

The reason for this change is that having a global namespace for
includes isn't a good idea. It defeats one of the advantages of having
folders and it introduces problems that are sometimes subtle (because
you may not know the header you are actually including if there are two
of them).

For example, this patch had to be created because two headers were
called the same way: e0ea0928 ("Fix gpio includes of mt8173 platform
to avoid collision."). More recently, this patch has had similar
problems: 46f9b2c3 ("drivers: add tzc380 support").

This problem was introduced in commit 4ecca339

 ("Move include and
source files to logical locations"). At that time, there weren't too
many headers so it wasn't a real issue. However, time has shown that
this creates problems.

Platforms that want to preserve the way they include headers may add the
removed paths to PLAT_INCLUDES, but this is discouraged.

Change-Id: I39dc53ed98f9e297a5966e723d1936d6ccf2fc8f
Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>

drivers/marvell/mochi/cp110_setup.c

@@ -7,11 +7,12 @@
 
 /* CP110 Marvell SoC driver */
 
-#include <amb_adec.h>
-#include <cp110_setup.h>
-#include <debug.h>
-#include <delay_timer.h>
-#include <iob.h>
+#include <common/debug.h>
+#include <drivers/delay_timer.h>
+#include <drivers/marvell/amb_adec.h>
+#include <drivers/marvell/iob.h>
+#include <drivers/marvell/mochi/cp110_setup.h>
+
 #include <plat_marvell.h>
 
 /*

drivers/marvell/thermal.c

@@ -7,8 +7,8 @@
 
 /* Driver for thermal unit located in Marvell ARMADA 8K and compatible SoCs */
 
-#include <debug.h>
-#include <thermal.h>
+#include <common/debug.h>
+#include <drivers/marvell/thermal.h>
 
 int marvell_thermal_init(struct tsen_config *tsen_cfg)
 {

drivers/marvell/uart/a3700_console.S

@@ -7,9 +7,9 @@
 
 #include <arch.h>
 #include <asm_macros.S>
-#include <a3700_console.h>
 #define USE_FINISH_CONSOLE_REG_2
 #include <console_macros.S>
+#include <drivers/marvell/uart/a3700_console.h>
 
 	/*
 	 * "core" functions are low-level implementations that don't require

drivers/mentor/i2c/mi2cv.c

@@ -11,12 +11,14 @@
  * for Marvell and Allwinner SoCs in ATF.
  */
 
-#include <debug.h>
-#include <delay_timer.h>
 #include <errno.h>
-#include <mentor/mi2cv.h>
+
+#include <common/debug.h>
+#include <drivers/delay_timer.h>
+#include <drivers/mentor/mi2cv.h>
+#include <lib/mmio.h>
+
 #include <mentor_i2c_plat.h>
-#include <mmio.h>
 
 #if LOG_LEVEL >= LOG_LEVEL_VERBOSE
 #define DEBUG_I2C

drivers/meson/console/aarch64/meson_console.S

@@ -8,7 +8,7 @@
 #include <assert_macros.S>
 #define USE_FINISH_CONSOLE_REG_2
 #include <console_macros.S>
-#include <meson_console.h>
+#include <drivers/meson/meson_console.h>
 
 	.globl console_meson_register
 	.globl console_meson_init

drivers/mmc/mmc.c

@@ -6,15 +6,16 @@
 
 /* Define a simple and generic interface to access eMMC and SD-card devices. */
 
-#include <arch_helpers.h>
 #include <assert.h>
-#include <debug.h>
-#include <delay_timer.h>
 #include <errno.h>
-#include <mmc.h>
 #include <stdbool.h>
 #include <string.h>
-#include <utils.h>
+
+#include <arch_helpers.h>
+#include <common/debug.h>
+#include <drivers/delay_timer.h>
+#include <drivers/mmc.h>
+#include <lib/utils.h>
 
 #define MMC_DEFAULT_MAX_RETRIES		5
 #define SEND_OP_COND_MAX_RETRIES	100

drivers/partition/gpt.c

@@ -5,11 +5,12 @@
  */
 
 #include <assert.h>
-#include <debug.h>
 #include <errno.h>
-#include <gpt.h>
 #include <string.h>
-#include <utils.h>
+
+#include <common/debug.h>
+#include <drivers/partition/gpt.h>
+#include <lib/utils.h>
 
 static int unicode_to_ascii(unsigned short *str_in, unsigned char *str_out)
 {

drivers/partition/partition.c

@@ -5,15 +5,16 @@
  */
 
 #include <assert.h>
-#include <debug.h>
-#include <gpt.h>
-#include <io_storage.h>
-#include <mbr.h>
-#include <partition.h>
-#include <platform.h>
 #include <stdio.h>
 #include <string.h>
 
+#include <common/debug.h>
+#include <drivers/io/io_storage.h>
+#include <drivers/partition/partition.h>
+#include <drivers/partition/gpt.h>
+#include <drivers/partition/mbr.h>
+#include <plat/common/platform.h>
+
 static uint8_t mbr_sector[PARTITION_BLOCK_SIZE];
 partition_entry_list_t list;
 

drivers/renesas/rcar/auth/auth_mod.c

@@ -5,13 +5,15 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include <arch_helpers.h>
-#include <debug.h>
-#include <mmio.h>
-#include <platform.h>
-#include <platform_def.h>
 #include <stddef.h>
 
+#include <platform_def.h>
+
+#include <arch_helpers.h>
+#include <common/debug.h>
+#include <lib/mmio.h>
+#include <plat/common/platform.h>
+
 #include "rom_api.h"
 
 typedef int32_t(*secure_boot_api_f) (uint32_t a, uint32_t b, void *c);

drivers/renesas/rcar/avs/avs_driver.c

@@ -4,9 +4,10 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include <mmio.h>
-#include <debug.h>
-#include <utils_def.h>
+#include <common/debug.h>
+#include <lib/mmio.h>
+#include <lib/utils_def.h>
+
 #include "cpg_registers.h"
 #include "avs_driver.h"
 #include "rcar_def.h"

drivers/renesas/rcar/board/board.c

@@ -6,9 +6,12 @@
  */
 
 #include <stdint.h>
+
+#include <lib/utils_def.h>
+
 #include <iic_dvfs.h>
+
 #include "board.h"
-#include "utils_def.h"
 
 #ifndef BOARD_DEFAULT
 #if (RCAR_LSI == RCAR_E3)

drivers/renesas/rcar/common.c

@@ -4,7 +4,8 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include <mmio.h>
+#include <lib/mmio.h>
+
 #include "rcar_private.h"
 
 void

drivers/renesas/rcar/console/rcar_printf.c

@@ -4,13 +4,15 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include <debug.h>
 #include <stdarg.h>
 #include <stdint.h>
 
-#include	<arch_helpers.h>
 #include <platform_def.h>
-#include	<bakery_lock.h>
+
+#include <arch_helpers.h>
+#include <common/debug.h>
+#include <lib/bakery_lock.h>
+
 #include "rcar_def.h"
 #include "rcar_private.h"
 #include "rcar_printf.h"

drivers/renesas/rcar/cpld/ulcb_cpld.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include <mmio.h>
+#include <lib/mmio.h>
 
 #define SCLK			8	/* GP_6_8 */
 #define SSTBZ			3	/* GP_2_3 */

drivers/renesas/rcar/delay/micro_delay.h

@@ -10,7 +10,7 @@
 #define TMU3_MEASUREMENT	(0)
 
 #ifndef __ASSEMBLY__
-#include "stdint.h"
+#include <stdint.h>
 void rcar_micro_delay(uint32_t count_us);
 
 #if (TMU3_MEASUREMENT == 1)

drivers/renesas/rcar/dma/dma_driver.c

@@ -5,12 +5,14 @@
  */
 
 #include <stdint.h>
-#include <arch_helpers.h>
 #include <string.h>
-#include <mmio.h>
+
+#include <arch_helpers.h>
+#include <common/debug.h>
+#include <lib/mmio.h>
+
 #include "rcar_def.h"
 #include "cpg_registers.h"
-#include "debug.h"
 #include "rcar_private.h"
 
 /* DMA CHANNEL setting (0/16/32) */

drivers/renesas/rcar/emmc/emmc_cmd.c

@@ -4,7 +4,8 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include <debug.h>
+#include <common/debug.h>
+
 #include "emmc_config.h"
 #include "emmc_hal.h"
 #include "emmc_std.h"

drivers/renesas/rcar/emmc/emmc_init.c

@@ -5,7 +5,9 @@
  */
 
 #include <stddef.h>
-#include <mmio.h>
+
+#include <lib/mmio.h>
+
 #include "emmc_config.h"
 #include "emmc_hal.h"
 #include "emmc_std.h"

drivers/renesas/rcar/emmc/emmc_interrupt.c

@@ -5,6 +5,9 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
+#include <stddef.h>
+
+#include <lib/mmio.h>
 
 #include "emmc_config.h"
 #include "emmc_def.h"
@@ -13,9 +16,6 @@
 #include "emmc_std.h"
 #include "rcar_def.h"
 
-#include <mmio.h>
-#include <stddef.h>
-
 static EMMC_ERROR_CODE emmc_trans_sector(uint32_t *buff_address_virtual);
 
 uint32_t emmc_interrupt(void)

drivers/renesas/rcar/emmc/emmc_mount.c

@@ -4,8 +4,9 @@
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include <debug.h>
-#include <mmio.h>
+#include <common/debug.h>
+#include <lib/mmio.h>
+
 #include "emmc_config.h"
 #include "emmc_hal.h"
 #include "emmc_std.h"