From 8b1c43afb07975d03ac41630eb2c77b38d15f14f Mon Sep 17 00:00:00 2001
From: Marian Buschsieweke <marian.buschsieweke@posteo.net>
Date: Thu, 18 Jan 2024 21:16:42 +0100
Subject: [PATCH] cpu/gd32v: Allow configuration of SWJ_CFG

Expose the compile time configuration knob `CONFIG_AFIO_PCF0_SWJ_CFG`
to allow freeing some/all JTAG pins and use them as GPIOs.

As default, PB4 is remapped from NJTRST to be usable as regular GPIO.
This still allows using the JTAG interface for debugging/flashing,
but makes an GPIO exposed by some boards available.
---
 cpu/gd32v/cpu.c              |  9 +++++++++
 cpu/gd32v/include/cpu_conf.h | 28 ++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)

diff --git a/cpu/gd32v/cpu.c b/cpu/gd32v/cpu.c
index 81ce057c8c..f27d9166d1 100644
--- a/cpu/gd32v/cpu.c
+++ b/cpu/gd32v/cpu.c
@@ -33,6 +33,15 @@ void cpu_init(void)
     periph_clk_en(APB1, RCU_APB1EN_PMUEN_Msk);
     /* Common RISC-V initialization */
     riscv_init();
+
+    /* Apply configured SWJ_CFG, unless it is configured to the reset value */
+    if (CONFIG_AFIO_PCF0_SWJ_CFG != SWJ_CFG_FULL_JTAG) {
+        /* The remapping periph clock must first be enabled */
+        RCU->APB2EN |= RCU_APB2EN_AFEN_Msk;
+        /* Then the remap can occur */
+        AFIO->PCF0 |= CONFIG_AFIO_PCF0_SWJ_CFG;
+    }
+
     early_init();
     periph_init();
 }
diff --git a/cpu/gd32v/include/cpu_conf.h b/cpu/gd32v/include/cpu_conf.h
index eab6b59b9f..97e3f95413 100644
--- a/cpu/gd32v/include/cpu_conf.h
+++ b/cpu/gd32v/include/cpu_conf.h
@@ -46,6 +46,34 @@ extern "C" {
 #define CPU_FLASH_BASE                  0x08000000
 /** @} */
 
+/**
+ * @brief   Possible values of the `SWJ_CFG` field in the AFIO->PCF0 register
+ */
+typedef enum {
+     /**
+      * @brief  Full JTAG interface (reset value)
+      */
+    SWJ_CFG_FULL_JTAG    = 0,
+    /**
+     * @brief   JTAG enabled, but NJTRST disabled and pin PB4 usable as GPIO
+     */
+    SWJ_CFG_NO_NJTRST   = 1U << AFIO_PCF0_SWJ_CFG_Pos,
+    /**
+     * @brief   JTAG disabled, all debug pins usable as GPIOs
+     */
+    SWJ_CFG_NO_JTAG     = 4U << AFIO_PCF0_SWJ_CFG_Pos,
+} afio_pcf0_swj_cfg_t;
+
+#ifndef CONFIG_AFIO_PCF0_SWJ_CFG
+/**
+ * @brief   By default, enable JTAG but disable NJTRST
+ *
+ * This default makes PB4 usable as GPIO while still being able to debug and
+ * flash via JTAG.
+ */
+#define CONFIG_AFIO_PCF0_SWJ_CFG    SWJ_CFG_NO_NJTRST
+#endif
+
 #ifdef __cplusplus
 }
 #endif