From 0acb666da680a5a457dfa5659a2e341a4b4e6283 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Wed, 27 Mar 2024 10:50:23 +0100 Subject: [PATCH 1/4] gnrc_mac: deprecate module --- makefiles/deprecated_modules.inc.mk | 1 + sys/include/net/gnrc/mac/mac.h | 2 ++ 2 files changed, 3 insertions(+) diff --git a/makefiles/deprecated_modules.inc.mk b/makefiles/deprecated_modules.inc.mk index 8f051d934b24..858d5ded5d8a 100644 --- a/makefiles/deprecated_modules.inc.mk +++ b/makefiles/deprecated_modules.inc.mk @@ -1,4 +1,5 @@ # Add deprecated modules here # Keep this list ALPHABETICALLY SORTED!!!!111elven +DEPRECATED_MODULES += gnrc_mac DEPRECATED_MODULES += sema_deprecated DEPRECATED_MODULES += ztimer_now64 diff --git a/sys/include/net/gnrc/mac/mac.h b/sys/include/net/gnrc/mac/mac.h index 807fecd898e1..f0fed0934e92 100644 --- 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. * * @{ * From 2deb8882dde76a307fc0a1486693aee6630fabb3 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Wed, 27 Mar 2024 10:51:00 +0100 Subject: [PATCH 2/4] gnrc_lwmac: deprecate module --- makefiles/deprecated_modules.inc.mk | 2 ++ sys/include/net/gnrc/lwmac/lwmac.h | 2 ++ sys/include/net/gnrc/nettype.h | 7 ++++++- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/makefiles/deprecated_modules.inc.mk b/makefiles/deprecated_modules.inc.mk index 858d5ded5d8a..f624e5574005 100644 --- a/makefiles/deprecated_modules.inc.mk +++ b/makefiles/deprecated_modules.inc.mk @@ -1,5 +1,7 @@ # Add deprecated modules here # Keep this list ALPHABETICALLY SORTED!!!!111elven +DEPRECATED_MODULES += gnrc_lwmac DEPRECATED_MODULES += gnrc_mac +DEPRECATED_MODULES += gnrc_nettype_lwmac DEPRECATED_MODULES += sema_deprecated DEPRECATED_MODULES += ztimer_now64 diff --git a/sys/include/net/gnrc/lwmac/lwmac.h b/sys/include/net/gnrc/lwmac/lwmac.h index 2871fd9fe9b2..01cf86de74e5 100644 --- 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/nettype.h b/sys/include/net/gnrc/nettype.h index 34aea25fa4c1..a12b0ed7d3eb 100644 --- a/sys/include/net/gnrc/nettype.h +++ b/sys/include/net/gnrc/nettype.h @@ -69,7 +69,12 @@ typedef enum { GNRC_NETTYPE_GOMACH, /**< Protocol is 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 */ From 653417d89565e4565bb23cf86045826e2a6c546c Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Wed, 27 Mar 2024 10:51:12 +0100 Subject: [PATCH 3/4] gnrc_gomach: deprecate module --- makefiles/deprecated_modules.inc.mk | 2 ++ sys/include/net/gnrc/gomach/gomach.h | 2 ++ sys/include/net/gnrc/nettype.h | 7 ++++++- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/makefiles/deprecated_modules.inc.mk b/makefiles/deprecated_modules.inc.mk index f624e5574005..223a60a80cd5 100644 --- a/makefiles/deprecated_modules.inc.mk +++ b/makefiles/deprecated_modules.inc.mk @@ -1,7 +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/sys/include/net/gnrc/gomach/gomach.h b/sys/include/net/gnrc/gomach/gomach.h index 04eb0145641d..4098d36874bd 100644 --- 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/nettype.h b/sys/include/net/gnrc/nettype.h index a12b0ed7d3eb..4534d02306ec 100644 --- a/sys/include/net/gnrc/nettype.h +++ b/sys/include/net/gnrc/nettype.h @@ -66,7 +66,12 @@ 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) /** From 0e2ab509fb6629c711bd923d9cfadcb926ec1e79 Mon Sep 17 00:00:00 2001 From: Martine Lenders Date: Wed, 27 Mar 2024 11:06:32 +0100 Subject: [PATCH 4/4] opendsme: fix markdown formatting of ASCII art in documentation --- pkg/opendsme/include/opendsme/opendsme.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/pkg/opendsme/include/opendsme/opendsme.h b/pkg/opendsme/include/opendsme/opendsme.h index cbcbbc6d6db2..e3d2324a5d7c 100644 --- 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