drivers/mrf24j40: add support for IEEE 802.15.4 Radio HAL

boards/common/nucleo64/include/board.h

@@ -87,6 +87,32 @@ static const motor_driver_config_t motor_driver_config[] = {
 #define MOTOR_DRIVER_NUMOF           ARRAY_SIZE(motor_driver_config)
 /** @} */
 
+/**
+ * @name Describe MRF24J40 radio
+ * @{
+ */
+#ifndef MRF24J40_PARAM_SPI
+#define MRF24J40_PARAM_SPI      SPI_DEV(0)
+#endif
+
+#ifndef MRF24J40_PARAM_SPI_CLK
+#define MRF24J40_PARAM_SPI_CLK  SPI_CLK_5MHZ
+#endif
+
+#ifndef MRF24J40_PARAM_CS
+#define MRF24J40_PARAM_CS       ARDUINO_PIN_10
+#endif
+
+#ifndef MRF24J40_PARAM_INT
+#define MRF24J40_PARAM_INT      ARDUINO_PIN_7
+#endif
+
+#ifndef MRF24J40_PARAM_RESET
+#define MRF24J40_PARAM_RESET    ARDUINO_PIN_5
+#endif
+
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif

core/lib/include/bitarithm.h

@@ -66,6 +66,8 @@ extern "C" {
 #define BIT7  0x00000080 /**< Bit 7 set define */
 #define BIT8  0x00000100 /**< Bit 8 set define */
 #define BIT9  0x00000200 /**< Bit 9 set define */
+#endif
+#ifndef BIT10
 #define BIT10 0x00000400 /**< Bit 10 set define */
 #define BIT11 0x00000800 /**< Bit 11 set define */
 #define BIT12 0x00001000 /**< Bit 12 set define */

cpu/atmega128rfa1/Kconfig

@@ -11,6 +11,7 @@ config CPU_MODEL_ATMEGA128RFA1
     select CPU_FAM_ATMEGA128
     select HAS_CPU_ATMEGA128RFA1
     select HAS_ATMEGA_PCINT1
+    select HAVE_AT86RFA1
 
 ## Definition of specific features
 config HAS_CPU_ATMEGA128RFA1

cpu/atmega256rfr2/Kconfig

@@ -15,6 +15,7 @@ config CPU_MODEL_ATMEGA256RFR2
     select CPU_FAM_ATMEGA256RF
     select HAS_ATMEGA_PCINT1
     select HAS_CPU_ATMEGA256RFR2
+    select HAVE_AT86RFR2
 
 ## Definition of specific features
 config HAS_CPU_ATMEGA256RFR2

dist/tools/doccheck/exclude_patterns

@@ -902,6 +902,12 @@ boards/common/nucleo64/include/arduino_pinmap\.h:[0-9]+: warning: Member ARDUINO
 boards/common/nucleo64/include/arduino_pinmap\.h:[0-9]+: warning: Member ARDUINO_PIN_A5 \(macro definition\) of file arduino_pinmap\.h is not documented\.
 boards/common/nucleo64/include/board\.h:[0-9]+: warning: Member MOTOR_DRIVER_NUMOF \(macro definition\) of group boards_common_nucleo64 is not documented\.
 boards/common/nucleo64/include/board\.h:[0-9]+: warning: Member motor_driver_config\[\] \(variable\) of group boards_common_nucleo64 is not documented\.
+boards/common/nucleo64/include/board\.h:[0-9]+: warning: Member MRF24J40_PARAMS \(macro definition\) of group boards_common_nucleo64 is not documented\.
+boards/common/nucleo64/include/board\.h:[0-9]+: warning: Member MRF24J40_PARAM_CS \(macro definition\) of group boards_common_nucleo64 is not documented\.
+boards/common/nucleo64/include/board\.h:[0-9]+: warning: Member MRF24J40_PARAM_INT \(macro definition\) of group boards_common_nucleo64 is not documented\.
+boards/common/nucleo64/include/board\.h:[0-9]+: warning: Member MRF24J40_PARAM_RESET \(macro definition\) of group boards_common_nucleo64 is not documented\.
+boards/common/nucleo64/include/board\.h:[0-9]+: warning: Member MRF24J40_PARAM_SPI \(macro definition\) of group boards_common_nucleo64 is not documented\.
+boards/common/nucleo64/include/board\.h:[0-9]+: warning: Member MRF24J40_PARAM_SPI_CLK \(macro definition\) of group boards_common_nucleo64 is not documented\.
 boards/common/particle\-mesh/include/board\.h:[0-9]+: warning: Member LED_MASK \(macro definition\) of file board\.h is not documented\.
 boards/common/particle\-mesh/include/board\.h:[0-9]+: warning: Member LED_PORT \(macro definition\) of file board\.h is not documented\.
 boards/common/particle\-mesh/include/periph_conf_common\.h:[0-9]+: warning: Member PWM_NUMOF \(macro definition\) of file periph_conf_common\.h is not documented\.
@@ -9100,6 +9106,13 @@ drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_
 drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_PACON2_TXONTS2 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
 drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_PACON2_TXONTS3 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
 drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_REG_ACKTMOUT \(macro definition\) of file mrf24j40_registers\.h is not documented\.
+drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_ACKTMOUT_MAWD0 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
+drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_ACKTMOUT_MAWD1 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
+drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_ACKTMOUT_MAWD2 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
+drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_ACKTMOUT_MAWD3 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
+drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_ACKTMOUT_MAWD4 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
+drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_ACKTMOUT_MAWD5 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
+drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_ACKTMOUT_MAWD6 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
 drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_REG_ASSOEADR0 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
 drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_REG_ASSOEADR1 \(macro definition\) of file mrf24j40_registers\.h is not documented\.
 drivers/mrf24j40/include/mrf24j40_registers\.h:[0-9]+: warning: Member MRF24J40_REG_ASSOEADR2 \(macro definition\) of file mrf24j40_registers\.h is not documented\.

drivers/Makefile.dep

@@ -122,7 +122,6 @@ endif
 ifneq (,$(filter nrfmin,$(USEMODULE)))
   FEATURES_REQUIRED += radio_nrfmin
   FEATURES_REQUIRED += periph_cpuid
-  USEMODULE += netif
 endif
 
 ifneq (,$(filter nrf24l01p_ng_%,$(USEMODULE)))

drivers/include/mrf24j40.h

@@ -71,6 +71,7 @@
 #include "net/netdev.h"
 #include "net/netdev/ieee802154.h"
 #include "net/gnrc/nettype.h"
+#include "net/ieee802154/radio.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -105,6 +106,11 @@ extern "C" {
 
 #define MRF24J40_MAX_FRAME_RETRIES      (3U)        /**< Number of frame retries (fixed) */
 
+#define MRF24J40_MAX_MINBE              (3U)        /**< Maximum value of minimum
+                                                         exponential backoff */
+#define MRF24J40_MIN_TXPOWER            (-36)       /**< Minimum transmission power (dBm) */
+#define MRF24J40_MAX_TXPOWER            (0)         /**< Maximum transmission power (dBm) */
+
 /**
  * @defgroup drivers_mrf24j40_config     mrf24j40 driver compile configuration
  * @ingroup drivers_mrf24j40
@@ -151,29 +157,13 @@ typedef struct mrf24j40_params {
  * @brief   Device descriptor for MRF24J40 radio devices
  */
 typedef struct {
-    netdev_ieee802154_t netdev;             /**< netdev parent struct */
     /*  device specific fields  */
-    mrf24j40_params_t params;               /**< parameters for initialization */
-    uint8_t state;                          /**< current state of the radio */
-    uint8_t idle_state;                     /**< state to return to after sending */
-    uint8_t tx_frame_len;                   /**< length of the current TX frame */
-    uint8_t header_len;                     /**< length of the header */
+    const mrf24j40_params_t *params;        /**< parameters for initialization */
     uint8_t fcf_low;                        /**< Low 8 FCF bits of the current TX frame. */
     uint8_t pending;                        /**< Flags for pending tasks */
-    uint8_t irq_flag;                       /**< Flags for IRQs */
-    uint8_t tx_retries;                     /**< Number of retries needed for last transmission */
+    bool tx_pending;                        /**< Whether a transmission is pending or not */
 } mrf24j40_t;
 
-/**
- * @brief   Setup an MRF24J40 based device state
- *
- * @param[out] dev          device descriptor
- * @param[in]  params       parameters for device initialization
- * @param[in]  index        index of @p params in a global parameter struct array.
- *                          If initialized manually, pass a unique identifier instead.
- */
-void mrf24j40_setup(mrf24j40_t *dev, const mrf24j40_params_t *params, uint8_t index);
-
 /**
  * @brief   Trigger a hardware reset and configure radio with default values
  *
@@ -183,26 +173,6 @@ void mrf24j40_setup(mrf24j40_t *dev, const mrf24j40_params_t *params, uint8_t in
  */
 int mrf24j40_reset(mrf24j40_t *dev);
 
-/**
- * @brief   Trigger a clear channel assessment & retrieve RSSI
- *
- * @param[in] dev           device to use
- * @param[in] rssi          RSSI value from register in dBm
- *
- * @return                  true if channel is clear
- * @return                  false if channel is busy
- */
-bool mrf24j40_cca(mrf24j40_t *dev, int8_t *rssi);
-
-/**
- * @brief   Get the short address of the given device
- *
- * @param[in] dev           device to read from
- *
- * @return                  the currently set (2-byte) short address
- */
-uint16_t mrf24j40_get_addr_short(mrf24j40_t *dev);
-
 /**
  * @brief   Set the short address of the given device
  *
@@ -211,14 +181,6 @@ uint16_t mrf24j40_get_addr_short(mrf24j40_t *dev);
  */
 void mrf24j40_set_addr_short(mrf24j40_t *dev, uint16_t addr);
 
-/**
- * @brief   Get the configured long address of the given device
- *
- * @param[in]  dev          device to read from
- * @param[out] addr         the currently set (8-byte) long address
- */
-void mrf24j40_get_addr_long(mrf24j40_t *dev, uint8_t *addr);
-
 /**
  * @brief   Set the long address of the given device
  *
@@ -261,15 +223,6 @@ uint16_t mrf24j40_get_pan(mrf24j40_t *dev);
  */
 void mrf24j40_set_pan(mrf24j40_t *dev, uint16_t pan);
 
-/**
- * @brief   Get the configured transmission power of the given device [in dBm]
- *
- * @param[in] dev           device to read from
- *
- * @return                  configured transmission power in dBm
- */
-int16_t mrf24j40_get_txpower(mrf24j40_t *dev);
-
 /**
  * @brief   Set the transmission power of the given device [in dBm]
  *
@@ -283,15 +236,6 @@ int16_t mrf24j40_get_txpower(mrf24j40_t *dev);
  */
 void mrf24j40_set_txpower(mrf24j40_t *dev, int16_t txpower);
 
-/**
- * @brief   Get the maximum number of channel access attempts per frame (CSMA)
- *
- * @param[in] dev           device to read from
- *
- * @return                  configured number of retries
- */
-uint8_t mrf24j40_get_csma_max_retries(mrf24j40_t *dev);
-
 /**
  * @brief   Set the maximum number of channel access attempts per frame (CSMA)
  *
@@ -317,15 +261,6 @@ void mrf24j40_set_csma_max_retries(mrf24j40_t *dev, int8_t retries);
  */
 void mrf24j40_set_csma_backoff_exp(mrf24j40_t *dev, uint8_t min, uint8_t max);
 
-/**
- * @brief   Get the CCA threshold value
- *
- * @param[in] dev           device to read value from
- *
- * @return                  the current CCA threshold value
- */
-int8_t mrf24j40_get_cca_threshold(mrf24j40_t *dev);
-
 /**
  * @brief   Set the CCA threshold value
  *
@@ -364,34 +299,19 @@ void mrf24j40_set_state(mrf24j40_t *dev, uint8_t state);
  */
 void mrf24j40_set_turbo(mrf24j40_t *dev, bool enable);
 
-/**
- * @brief   Query the state of the turbo mode
- *
- * @param[in] dev           device to query
- * @return                  true if Turbo Mode is enabled
- */
-bool mrf24j40_get_turbo(mrf24j40_t *dev);
-
 /**
  * @brief   Put in sleep mode
  *
  * @param[in] dev       device to put to sleep
  */
 void mrf24j40_sleep(mrf24j40_t *dev);
 
-/**
- * @brief   Put in sleep mode if idle_state is sleep
- *
- * @param[in] dev       device to put to sleep
- */
-void mrf24j40_assert_sleep(mrf24j40_t *dev);
-
 /**
  * @brief   Wake up from sleep mode
  *
  * @param[in] dev       device to eventually wake up
  */
-void mrf24j40_assert_awake(mrf24j40_t *dev);
+void mrf24j40_wake_up(mrf24j40_t *dev);
 
 /**
  * @brief   Reset the internal state machine to TRX_OFF mode.
@@ -452,6 +372,27 @@ size_t mrf24j40_tx_load(mrf24j40_t *dev, uint8_t *data, size_t len,
  */
 void mrf24j40_tx_exec(mrf24j40_t *dev);
 
+/**
+ * @brief   IRQ Handler for the MRF24J40 device
+ *
+ * @param[in] dev          pointer to the IEEE 802.15.4 Radio HAL descriptor
+ */
+void mrf24j40_radio_irq_handler(void *dev);
+
+/**
+ * @brief   Initialize the given MRF24J40 device
+ * @param[out] dev         device descriptor
+ * @param[in]  params      parameters for device initialization
+ * @param[in]  hal         pointer to IEEE 802.15.4 Radio HAL descriptor
+ * @param[in]  cb          ISR callback
+ * @param[in]  ctx         context pointer handed to isr
+ *
+ * @return                 0 on success
+ * @return                 <0 on error
+ */
+int mrf24j40_init(mrf24j40_t *dev, const mrf24j40_params_t *params, ieee802154_dev_t *hal,
+                   gpio_cb_t cb, void *ctx);
+
 #ifdef __cplusplus
 }
 #endif

drivers/mrf24j40/Kconfig

@@ -13,14 +13,14 @@ menuconfig MODULE_MRF24J40
     depends on HAS_PERIPH_GPIO
     depends on HAS_PERIPH_GPIO_IRQ
     depends on HAS_PERIPH_SPI
-    select MODULE_IEEE802154
-    select MODULE_NETDEV
-    select MODULE_NETDEV_IEEE802154
-    select MODULE_NETDEV_LEGACY_API
     select MODULE_PERIPH_GPIO
     select MODULE_PERIPH_GPIO_IRQ
     select MODULE_PERIPH_SPI
-    select MODULE_XTIMER
+    select MODULE_IEEE802154
+    select MODULE_ZTIMER_USEC
+    select HAVE_BHP_IRQ_HANDLER
+    select HAVE_IEEE802154_RADIO_HAL_INTERFACE
+    select MRF24J40_OQPSK if MODULE_NETDEV
 
 if MODULE_MRF24J40
 

drivers/mrf24j40/Makefile.dep

@@ -1,11 +1,12 @@
+USEMODULE += ztimer_usec
 USEMODULE += ieee802154
-USEMODULE += netdev_ieee802154
-USEMODULE += netdev_legacy_api
-USEMODULE += xtimer
+USEMODULE += bhp
+
 FEATURES_REQUIRED += periph_gpio
 FEATURES_REQUIRED += periph_gpio_irq
 FEATURES_REQUIRED += periph_spi
 
-ifneq (,$(filter mrf24j40m%,$(USEMODULE)))
+ifneq (,$(filter netdev,$(USEMODULE)))
+  USEMODULE += netdev_ieee802154_submac
   DEFAULT_MODULE += netdev_ieee802154_oqpsk
 endif

drivers/mrf24j40/include/mrf24j40_internal.h

@@ -37,7 +37,7 @@ extern "C" {
  *
  * @return 0 on success, error otherwise
  */
-int mrf24j40_init(mrf24j40_t *dev);
+int mrf24j40_init_hw(mrf24j40_t *dev);
 
 /**
  * @brief Read from a register with a  at address `addr` from device `dev`. Register with 8bit address
@@ -151,6 +151,13 @@ void mrf24j40_enable_lna(mrf24j40_t *dev);
 static inline void mrf24j40_enable_lna(mrf24j40_t *dev) { (void) dev; }
 #endif
 
+/**
+ * @brief   Flush the RX FIFO
+ *
+ * @param[in] dev       device to flush the RX FIFO
+ */
+void mrf24j40_flush_rx(mrf24j40_t *dev);
+
 #ifdef __cplusplus
 }
 #endif

drivers/mrf24j40/include/mrf24j40_registers.h

@@ -219,6 +219,28 @@ extern "C" {
 
 /** @} */
 
+/**
+ * @brief    Shift offsets for TXMCR register (0x11)
+ * @{
+ */
+#define MRF24J40_TXMCR_MACMINBE_SHIFT           (3U)
+/** @} */
+
+/**
+ * @brief   Bitfield definitions for the ACKTMOUT register (0x12)
+ * @{
+ */
+#define MRF24J40_ACKTMOUT_DRPACK                (0x80)
+#define MRF24J40_ACKTMOUT_MAWD6                 (0x40)
+#define MRF24J40_ACKTMOUT_MAWD5                 (0x20)
+#define MRF24J40_ACKTMOUT_MAWD4                 (0x10)
+#define MRF24J40_ACKTMOUT_MAWD3                 (0x08)
+#define MRF24J40_ACKTMOUT_MAWD2                 (0x04)
+#define MRF24J40_ACKTMOUT_MAWD1                 (0x02)
+#define MRF24J40_ACKTMOUT_MAWD0                 (0x01)
+
+/** @} */
+
 /**
  * @name    Bitfield definitions for the PACON2 register (0x18)
  * @{