From cf74b26c55efad0b2e7eda94900a800648fba28c Mon Sep 17 00:00:00 2001
From: MrKevinWeiss <weiss.kevin604@gmail.com>
Date: Wed, 1 Dec 2021 10:35:53 +0100
Subject: [PATCH] cpu/mips: deprecate mips cpu

Add deprecate note in the mips cpu.
Add warning in make when any mips based board is being used (6lowpan-clicker, pic32-wifire).
---
 Makefile.include                   |  6 ++++++
 boards/6lowpan-clicker/doc.txt     |  2 ++
 boards/pic32-wifire/doc.txt        |  2 ++
 cpu/mips_pic32_common/doc.txt      |  2 ++
 makefiles/deprecated_boards.inc.mk | 11 +++++++++++
 makefiles/deprecated_cpus.inc.mk   | 10 ++++++++++
 6 files changed, 33 insertions(+)
 create mode 100644 makefiles/deprecated_boards.inc.mk
 create mode 100644 makefiles/deprecated_cpus.inc.mk

diff --git a/Makefile.include b/Makefile.include
index 7187bbedf0..68be673d70 100644
--- a/Makefile.include
+++ b/Makefile.include
@@ -392,6 +392,12 @@ INCLUDES += -I$(RIOTBASE)/core/include -I$(RIOTBASE)/drivers/include -I$(RIOTBAS
 # process provided features
 include $(RIOTBASE)/Makefile.features
 
+ifneq ($(RIOT_CI_BUILD),1)
+  # Warn about used deprecated boards
+  include $(RIOTMAKE)/deprecated_boards.inc.mk
+  include $(RIOTMAKE)/deprecated_cpus.inc.mk
+endif
+
 # mandatory includes!
 include $(RIOTMAKE)/pseudomodules.inc.mk
 include $(RIOTMAKE)/defaultmodules.inc.mk
diff --git a/boards/6lowpan-clicker/doc.txt b/boards/6lowpan-clicker/doc.txt
index f5af85a16f..7942ab8898 100644
--- a/boards/6lowpan-clicker/doc.txt
+++ b/boards/6lowpan-clicker/doc.txt
@@ -2,6 +2,8 @@
 @defgroup    boards_6lowpan-clicker MikroE 6LoWPAN Clicker
 @ingroup     boards
 @brief       Support for the MikroE 6LoWPAN Clicker
+@deprecated  Will not be available after the 2022.07 release. This includes
+             all MIPS based boards and cpus.
 
 ## Overview
 
diff --git a/boards/pic32-wifire/doc.txt b/boards/pic32-wifire/doc.txt
index c9b3c953a2..d94f058bba 100644
--- a/boards/pic32-wifire/doc.txt
+++ b/boards/pic32-wifire/doc.txt
@@ -2,6 +2,8 @@
 @defgroup    boards_pic32-wifire Digilent PIC32 WiFire
 @ingroup     boards
 @brief       Support for the Digilent PIC32 WiFire
+@deprecated  Will not be available after the 2022.07 release. This includes
+             all MIPS based boards and cpus.
 
 ## Overview
 
diff --git a/cpu/mips_pic32_common/doc.txt b/cpu/mips_pic32_common/doc.txt
index 3e6ca00a48..b4a90d2128 100644
--- a/cpu/mips_pic32_common/doc.txt
+++ b/cpu/mips_pic32_common/doc.txt
@@ -2,6 +2,8 @@
  * @defgroup        cpu_mips_pic32_common Microchip MIPS common
  * @ingroup         cpu
  * @brief           Microchip MIPS common
+ * @deprecated Will not be available after the 2022.07 release. This includes
+               all MIPS based boards and cpus.
  *
  * This module contains all common code and definition to all Microchip MIPS
  * cpu families supported by RIOT: @ref cpu_mips_pic32mx, @ref cpu_mips_pic32mz.
diff --git a/makefiles/deprecated_boards.inc.mk b/makefiles/deprecated_boards.inc.mk
new file mode 100644
index 0000000000..8647aef2cb
--- /dev/null
+++ b/makefiles/deprecated_boards.inc.mk
@@ -0,0 +1,11 @@
+# Add deprecated modules here
+# Keep this list ALPHABETICALLY SORTED!!!!
+ifeq ($(MAKELEVEL),0)
+  DEPRECATED_BOARDS += 6lowpan-clicker
+  DEPRECATED_BOARDS += pic32-wifire
+
+  ifneq (,$(filter $(DEPRECATED_BOARDS),$(BOARD)))
+    $(shell $(COLOR_ECHO) "$(COLOR_RED)Deprecated board: $(COLOR_RESET)"\
+                          "$(BOARD)" 1>&2)
+  endif
+endif
diff --git a/makefiles/deprecated_cpus.inc.mk b/makefiles/deprecated_cpus.inc.mk
new file mode 100644
index 0000000000..7109933d59
--- /dev/null
+++ b/makefiles/deprecated_cpus.inc.mk
@@ -0,0 +1,10 @@
+# Add deprecated modules here
+# Keep this list ALPHABETICALLY SORTED!!!!
+ifeq ($(MAKELEVEL),0)
+  DEPRECATED_CPUS += mips_pic32mx
+  DEPRECATED_CPUS += mips_pic32mz
+  ifneq (,$(filter $(DEPRECATED_CPUS),$(CPU)))
+    $(shell $(COLOR_ECHO) "$(COLOR_RED)Deprecated cpu: $(COLOR_RESET)"\
+                          "$(CPU)" 1>&2)
+  endif
+endif