Merge pull request #20512 from miri64/gnrc_mac/cleanup/deprecate

gnrc_mac / gnrc_lwmac / gnrc_gomach: Deprecate modules
RIOT-OS · Mar 27, 2024 · 29374c6 · 29374c6
2 parents 1b4f45f + 0e2ab50
commit 29374c6
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 10 deletions.
diff --git a/makefiles/deprecated_modules.inc.mk b/makefiles/deprecated_modules.inc.mk
@@ -1,4 +1,9 @@
 # Add deprecated modules here
 # Keep this list ALPHABETICALLY SORTED!!!!111elven
+DEPRECATED_MODULES += gnrc_gomach
+DEPRECATED_MODULES += gnrc_lwmac
+DEPRECATED_MODULES += gnrc_mac
+DEPRECATED_MODULES += gnrc_nettype_gomach
+DEPRECATED_MODULES += gnrc_nettype_lwmac
 DEPRECATED_MODULES += sema_deprecated
 DEPRECATED_MODULES += ztimer_now64
diff --git a/pkg/opendsme/include/opendsme/opendsme.h b/pkg/opendsme/include/opendsme/opendsme.h
@@ -40,14 +40,14 @@
  * of a series of superframes that repeat indefinitely. A superframe consists
  * of a Beacon Slot, a Contention Access Period and Contention Free Period.
  *
- *    BS                 CAP                      CFP        BS
- *   +------------------------------------------------------+----
- *   |   |                                |--|--|--|--|--|--|   | ...
- *   |   |                                |--|--|--|--|--|--|   |
- *   |   |                                |--|--|--|--|--|--|   | ...
- *   |   |                                |--|--|--|--|--|--|   |
- *   +---+--------------------------------+--+--+--+--+--+--+---+
- *   <------------------- Superframe ----------------------->
+ *      BS                 CAP                      CFP        BS
+ *     +------------------------------------------------------+----
+ *     |   |                                |--|--|--|--|--|--|   | ...
+ *     |   |                                |--|--|--|--|--|--|   |
+ *     |   |                                |--|--|--|--|--|--|   | ...
+ *     |   |                                |--|--|--|--|--|--|   |
+ *     +---+--------------------------------+--+--+--+--+--+--+---+
+ *     <------------------- Superframe ----------------------->
  *
  * Each period of the superframe serves a dedicated purpose:
  * - Beacon Slot: Used for beacon transmission. PAN Coordinators and Coordinators

diff --git a/sys/include/net/gnrc/gomach/gomach.h b/sys/include/net/gnrc/gomach/gomach.h
@@ -10,6 +10,8 @@
  * @defgroup    net_gnrc_gomach GoMacH
  * @ingroup     net_gnrc
  * @brief       A traffic-adaptive multi-channel MAC
+ * @deprecated  This module is deprecated and will be removed after the 2024.10 release.
+ *              As an alternative MAC layer for IEEE 802.15.4, you can use @ref pkg_opendsme.
  *
  *
  * GoMacH is, "a General, nearly Optimal MAC protocol for multi-Hop communications",

diff --git a/sys/include/net/gnrc/lwmac/lwmac.h b/sys/include/net/gnrc/lwmac/lwmac.h
@@ -11,6 +11,8 @@
  * @defgroup    net_gnrc_lwmac LWMAC
  * @ingroup     net_gnrc
  * @brief       A Lightweight duty-cycling 802.15.4 MAC protocol
+ * @deprecated  This module is deprecated and will be removed after the 2024.10 release.
+ *              As an alternative MAC layer for IEEE 802.15.4, you can use @ref pkg_opendsme.
  *
  *
  * ## LWMAC implementation

diff --git a/sys/include/net/gnrc/mac/mac.h b/sys/include/net/gnrc/mac/mac.h
@@ -11,6 +11,8 @@
  * @defgroup    net_gnrc_mac Common MAC module
  * @ingroup     net_gnrc
  * @brief       A MAC module for providing common MAC parameters and helper functions.
+ * @deprecated  This module is deprecated and will be removed after the 2024.10 release.
+ *              As an alternative, you can use @ref pkg_opendsme.
  *
  * @{
  *

diff --git a/sys/include/net/gnrc/nettype.h b/sys/include/net/gnrc/nettype.h
@@ -66,10 +66,20 @@ typedef enum {
      * @name Link layer
      */
 #if IS_USED(MODULE_GNRC_NETTYPE_GOMACH) || defined(DOXYGEN)
-    GNRC_NETTYPE_GOMACH,         /**< Protocol is GoMacH */
+    /**
+     * @brief       Protocol is GoMacH
+     * @deprecated  @ref net_gnrc_gomach was deprecated and will be removed after
+     *              the 2024.10 release together with this protocol type.
+     */
+    GNRC_NETTYPE_GOMACH,
 #endif
 #if IS_USED(MODULE_GNRC_NETTYPE_LWMAC) || defined(DOXYGEN)
-    GNRC_NETTYPE_LWMAC,          /**< Protocol is lwMAC */
+    /**
+     * @brief       Protocol is lwMAC
+     * @deprecated  @ref net_gnrc_lwmac was deprecated and will be removed after
+     *              the 2024.10 release together with this protocol type.
+     */
+    GNRC_NETTYPE_LWMAC,
 #endif
 #if IS_USED(MODULE_GNRC_NETTYPE_CUSTOM) || defined(DOXYGEN)
     GNRC_NETTYPE_CUSTOM,         /**< Custom ethertype */