From 4946a15f157917bdaffdd1fddc4e875d8cc75e7f Mon Sep 17 00:00:00 2001
From: Gerard Marull-Paretas <gerard@teslabs.com>
Date: Wed, 1 Jun 2022 12:35:35 +0200
Subject: [PATCH] soc: arm: gigadevice: use common API headers

Stop relying on <soc.h> to access HAL APIs. Use generic, per-API headers
instead. Note that <soc.h> has been left as is for now, since ARM MPU
relies on a fragile chain of includes/type definitions.

This change should improve compilation efficiency, as we no longer pull
APIs that are not needed. A similar approach is followed by STM32
drivers.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
---
 drivers/dac/dac_gd32.c                        | 4 +++-
 drivers/gpio/gpio_gd32.c                      | 4 +++-
 drivers/i2c/i2c_gd32.c                        | 4 +++-
 drivers/interrupt_controller/intc_gd32_exti.c | 3 ++-
 drivers/pinctrl/pinctrl_gd32_af.c             | 4 +++-
 drivers/pinctrl/pinctrl_gd32_afio.c           | 4 +++-
 drivers/pwm/pwm_gd32.c                        | 4 +++-
 drivers/serial/usart_gd32.c                   | 4 +++-
 drivers/spi/spi_gd32.c                        | 4 +++-
 modules/hal_gigadevice/CMakeLists.txt         | 1 +
 10 files changed, 27 insertions(+), 9 deletions(-)

diff --git a/drivers/dac/dac_gd32.c b/drivers/dac/dac_gd32.c
index 49282145a3e..3c909305c19 100644
--- a/drivers/dac/dac_gd32.c
+++ b/drivers/dac/dac_gd32.c
@@ -9,7 +9,9 @@
 #include <errno.h>
 #include <zephyr/drivers/pinctrl.h>
 #include <zephyr/drivers/dac.h>
-#include <soc.h>
+
+#include <gd32_dac.h>
+#include <gd32_rcu.h>
 
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(dac_gd32, CONFIG_DAC_LOG_LEVEL);
diff --git a/drivers/gpio/gpio_gd32.c b/drivers/gpio/gpio_gd32.c
index abd9cea225b..adbaeb2dbc1 100644
--- a/drivers/gpio/gpio_gd32.c
+++ b/drivers/gpio/gpio_gd32.c
@@ -8,7 +8,9 @@
 
 #include <zephyr/drivers/gpio.h>
 #include <zephyr/drivers/interrupt_controller/gd32_exti.h>
-#include <soc.h>
+
+#include <gd32_gpio.h>
+#include <gd32_rcu.h>
 
 #include "gpio_utils.h"
 
diff --git a/drivers/i2c/i2c_gd32.c b/drivers/i2c/i2c_gd32.c
index 89f46d2fd9e..36fbdf36d2f 100644
--- a/drivers/i2c/i2c_gd32.c
+++ b/drivers/i2c/i2c_gd32.c
@@ -11,7 +11,9 @@
 #include <zephyr/devicetree.h>
 #include <zephyr/drivers/pinctrl.h>
 #include <zephyr/drivers/i2c.h>
-#include <soc.h>
+
+#include <gd32_i2c.h>
+#include <gd32_rcu.h>
 
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(i2c_gd32, CONFIG_I2C_LOG_LEVEL);
diff --git a/drivers/interrupt_controller/intc_gd32_exti.c b/drivers/interrupt_controller/intc_gd32_exti.c
index 27c42778b50..c97ffb0e4a9 100644
--- a/drivers/interrupt_controller/intc_gd32_exti.c
+++ b/drivers/interrupt_controller/intc_gd32_exti.c
@@ -8,10 +8,11 @@
 
 #include <zephyr/device.h>
 #include <zephyr/drivers/interrupt_controller/gd32_exti.h>
-#include <soc.h>
 #include <zephyr/sys/__assert.h>
 #include <zephyr/sys/util_macro.h>
 
+#include <gd32_exti.h>
+
 /** Unsupported line indicator */
 #define EXTI_NOTSUP 0xFFU
 
diff --git a/drivers/pinctrl/pinctrl_gd32_af.c b/drivers/pinctrl/pinctrl_gd32_af.c
index 2978460887d..d5977be04ef 100644
--- a/drivers/pinctrl/pinctrl_gd32_af.c
+++ b/drivers/pinctrl/pinctrl_gd32_af.c
@@ -5,7 +5,9 @@
  */
 
 #include <zephyr/drivers/pinctrl.h>
-#include <soc.h>
+
+#include <gd32_gpio.h>
+#include <gd32_rcu.h>
 
 BUILD_ASSERT((GD32_PUPD_NONE == GPIO_PUPD_NONE) &&
 	     (GD32_PUPD_PULLUP == GPIO_PUPD_PULLUP) &&
diff --git a/drivers/pinctrl/pinctrl_gd32_afio.c b/drivers/pinctrl/pinctrl_gd32_afio.c
index 5a41d03b462..065aeab9a13 100644
--- a/drivers/pinctrl/pinctrl_gd32_afio.c
+++ b/drivers/pinctrl/pinctrl_gd32_afio.c
@@ -5,7 +5,9 @@
  */
 
 #include <zephyr/drivers/pinctrl.h>
-#include <soc.h>
+
+#include <gd32_gpio.h>
+#include <gd32_rcu.h>
 
 /** AFIO DT node */
 #define AFIO_NODE DT_NODELABEL(afio)
diff --git a/drivers/pwm/pwm_gd32.c b/drivers/pwm/pwm_gd32.c
index 407c41edbb8..f155d3e4f55 100644
--- a/drivers/pwm/pwm_gd32.c
+++ b/drivers/pwm/pwm_gd32.c
@@ -10,9 +10,11 @@
 
 #include <zephyr/drivers/pwm.h>
 #include <zephyr/drivers/pinctrl.h>
-#include <soc.h>
 #include <zephyr/sys/util_macro.h>
 
+#include <gd32_rcu.h>
+#include <gd32_timer.h>
+
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(pwm_gd32, CONFIG_PWM_LOG_LEVEL);
 
diff --git a/drivers/serial/usart_gd32.c b/drivers/serial/usart_gd32.c
index 0b11c2065f0..1aa680b38b1 100644
--- a/drivers/serial/usart_gd32.c
+++ b/drivers/serial/usart_gd32.c
@@ -8,7 +8,9 @@
 #include <errno.h>
 #include <zephyr/drivers/pinctrl.h>
 #include <zephyr/drivers/uart.h>
-#include <soc.h>
+
+#include <gd32_usart.h>
+#include <gd32_rcu.h>
 
 /* Unify GD32 HAL USART status register name to USART_STAT */
 #ifndef USART_STAT
diff --git a/drivers/spi/spi_gd32.c b/drivers/spi/spi_gd32.c
index 96a09b11dc2..fec8fce21d6 100644
--- a/drivers/spi/spi_gd32.c
+++ b/drivers/spi/spi_gd32.c
@@ -10,7 +10,9 @@
 #include <zephyr/kernel.h>
 #include <zephyr/drivers/pinctrl.h>
 #include <zephyr/drivers/spi.h>
-#include <soc.h>
+
+#include <gd32_rcu.h>
+#include <gd32_spi.h>
 
 #include <zephyr/logging/log.h>
 LOG_MODULE_REGISTER(spi_gd32);
diff --git a/modules/hal_gigadevice/CMakeLists.txt b/modules/hal_gigadevice/CMakeLists.txt
index 488da7648f9..2a469eef687 100644
--- a/modules/hal_gigadevice/CMakeLists.txt
+++ b/modules/hal_gigadevice/CMakeLists.txt
@@ -34,6 +34,7 @@ endif()
 zephyr_include_directories(${gd32_soc_sys_dir}/include)
 zephyr_include_directories(${gd32_std_dir}/include)
 zephyr_include_directories(${ZEPHYR_HAL_GIGADEVICE_MODULE_DIR}/include)
+zephyr_include_directories(${ZEPHYR_HAL_GIGADEVICE_MODULE_DIR}/common_include)
 
 zephyr_library_sources(${gd32_soc_sys_dir}/source/system_${CONFIG_SOC_SERIES}.c)