nrf_802154: rev ab926396fe37113664734181cc4dfbb53fb61863

This commit updates revision of the nrf_802154 component.

Signed-off-by: Rafał Kuźnia <[email protected]>

Author: e-rk

drivers/nrf_802154/CMakeLists.txt

@@ -36,12 +36,6 @@ add_library(nrf-802154-driver-interface INTERFACE)
 add_library(nrf-802154-serialization-interface INTERFACE)
 
 add_subdirectory(common)
-
 add_subdirectory(driver)
 add_subdirectory(sl)
-
 add_subdirectory(serialization)
-
-if (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/internal/CMakeLists.txt)
-  add_subdirectory(internal)
-endif ()

drivers/nrf_802154/common/include/nrf_802154.h

@@ -348,6 +348,29 @@ void nrf_802154_extended_address_set(const uint8_t * p_extended_address);
  */
 void nrf_802154_short_address_set(const uint8_t * p_short_address);
 
+/**
+ * @brief Sets the alternate short address of the device.
+ *
+ * The alternate short address should be used when you need to change the
+ * device short address without loss of connectivity.
+ * The API addresses a race condition, where a remote peer sends a frame destined
+ * to the old device address, but this device has already changed the short address
+ * to a new one. The alternate address should be cleared after a while, after the new
+ * short address becomes known to the peers.
+ *
+ * The API is meant to be used as follows:
+ * 1. Set the alternate short address to the current old address.
+ * 2. Set the primary short address (@ref nrf_802154_short_address_set) to the new address.
+ * 3. Wait until the new short address becomes known among the peers.
+ * 4. Clear the alternate short address.
+ *
+ * @param[in]  p_short_address  Pointer to the short address (2 bytes, little-endian).
+ *                              Setting this value to NULL clears the alternate address.
+ *
+ * This function makes a copy of the address.
+ */
+void nrf_802154_alternate_short_address_set(const uint8_t * p_short_address);
+
 #if !NRF_802154_SERIALIZATION_HOST || defined(DOXYGEN)
 /**
  * @}
@@ -415,7 +438,12 @@ bool nrf_802154_receive(void);
  * If the requested reception time is in the past, the function returns false and does not
  * schedule reception.
  *
- * A scheduled reception can be cancelled by a call to @ref nrf_802154_receive_at_cancel.
+ * The reception ends after the configured timeout has elapsed. This event is notified to the
+ * higher layer through the @ref nrf_802154_receive_failed notification with
+ * @ref NRF_802154_RX_ERROR_DELAYED_TIMEOUT status code.
+ *
+ * A scheduled reception can be cancelled by a call to @ref nrf_802154_receive_at_cancel or
+ * @ref nrf_802154_receive_at_scheduled_cancel.
  *
  * @note The identifier @p id must be unique. It must not have the same value as identifiers
  * of other delayed timeslots active at the moment, so that it can be mapped unambiguously
@@ -427,7 +455,8 @@ bool nrf_802154_receive(void);
  * @param[in]   channel  Radio channel on which the frame is to be received.
  * @param[in]   id       Identifier of the scheduled reception window. If the reception has been
  *                       scheduled successfully, the value of this parameter can be used in
- *                       @ref nrf_802154_receive_at_cancel to cancel it.
+ *                       @ref nrf_802154_receive_at_cancel or
+ *                       @ref nrf_802154_receive_at_scheduled_cancel to cancel it.
  *
  * @retval  true   The reception procedure was scheduled.
  * @retval  false  The driver could not schedule the reception procedure.
@@ -453,6 +482,35 @@ bool nrf_802154_receive_at(uint64_t rx_time,
  */
 bool nrf_802154_receive_at_cancel(uint32_t id);
 
+/**
+ * @brief Cancels a delayed reception scheduled by a call to @ref nrf_802154_receive_at.
+ *
+ * If the receive window has been scheduled but has not started yet, this function prevents
+ * entering the receive window. If the receive window has been scheduled and has already started,
+ * the receive window is not affected and will continue until its scheduled timeout.
+ *
+ * The function also returns success when no window with given ID is scheduled and is not currently
+ * ongoing.
+ *
+ * @note This function differs from @ref nrf_802154_receive_at_cancel in two aspects:
+ *       1. This function can only cancel receive windows that are scheduled, but haven't started yet.
+ *          If the receive window has already started, the cancel will end with failure and the
+ *          receive window will last for the planned duration, ending with
+ *          @ref nrf_802154_receive_failed notification with @ref NRF_802154_RX_ERROR_DELAYED_TIMEOUT
+ *          status.
+ *       2. If there are no scheduled and ongoing receive windows matching the given ID,
+ *          the function ends with a success.
+ *
+ * @param[in]  id  Identifier of the delayed reception window to be cancelled. If the provided
+ *                 value does not refer to any scheduled or active receive window, the function
+ *                 returns true.
+ *
+ * @retval  true    The delayed reception was scheduled and successfully cancelled or the
+ *                  receive window was not scheduled at all.
+ * @retval  false   The scheduled window is currently ongoing.
+ */
+bool nrf_802154_receive_at_scheduled_cancel(uint32_t id);
+
 /**
  * @brief Changes the radio state to @ref RADIO_STATE_TX.
  *

drivers/nrf_802154/common/include/nrf_802154_config.h

@@ -40,6 +40,7 @@
 #endif
 
 #include <nrfx.h>
+#include "nrf_802154_nrfx_addons.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -68,13 +69,20 @@ extern "C" {
 #endif
 
 /**
- * @def NRF_802154_CCA_ED_THRESHOLD_DEFAULT
+ * @def NRF_802154_CCA_ED_THRESHOLD_DBM_DEFAULT
  *
- * Energy detection threshold used in the CCA procedure.
+ * Energy detection threshold in dBm used in the CCA procedure.
+ *
+ * Note: NRF_802154_CCA_ED_THRESHOLD_DEFAULT is deprecated.
  *
  */
-#ifndef NRF_802154_CCA_ED_THRESHOLD_DEFAULT
-#define NRF_802154_CCA_ED_THRESHOLD_DEFAULT 0x14
+#ifdef NRF_802154_CCA_ED_THRESHOLD_DEFAULT
+#undef NRF_802154_CCA_ED_THRESHOLD_DBM_DEFAULT
+#define NRF_802154_CCA_ED_THRESHOLD_DBM_DEFAULT (ED_RSSIOFFS + NRF_802154_CCA_ED_THRESHOLD_DEFAULT)
+#else
+#ifndef NRF_802154_CCA_ED_THRESHOLD_DBM_DEFAULT
+#define NRF_802154_CCA_ED_THRESHOLD_DBM_DEFAULT (-75)
+#endif
 #endif
 
 /**
@@ -97,6 +105,23 @@ extern "C" {
 #define NRF_802154_CCA_CORR_LIMIT_DEFAULT 0x02
 #endif
 
+/**
+ * @def NRF_802154_CCAIDLE_TO_TXEN_EXTRA_TIME_US
+ *
+ * Additional time in microseconds that delays triggering of @c TXEN after the
+ * @c CCAIDLE event occurred. Default value for most use-cases is @c 0,
+ * In this scenario, the short between the @c CCAIDLE event and the
+ * @c TXEN task is used. If this value is non-zero, the short is not used.
+ * The triggering of @c TXEN occurs through (D)PPI and TIMER.
+ * A non-zero value may be necessary to ensure enough switching time for
+ * use with some Front-End Modules.
+ *
+ * This option is supported for the nRF53 Series and the nRF54L Series only.
+ */
+#ifndef NRF_802154_CCAIDLE_TO_TXEN_EXTRA_TIME_US
+#define NRF_802154_CCAIDLE_TO_TXEN_EXTRA_TIME_US 0U
+#endif
+
 /**
  * @def NRF_802154_INTERNAL_RADIO_IRQ_HANDLING
  *

drivers/nrf_802154/common/include/nrf_802154_types.h

@@ -162,7 +162,7 @@ typedef uint8_t nrf_802154_term_t;
 typedef struct
 {
     nrf_radio_cca_mode_t mode;           // !< CCA mode.
-    uint8_t              ed_threshold;   // !< Busy threshold of the CCA energy. Not used in @ref NRF_RADIO_CCA_MODE_CARRIER.
+    int8_t               ed_threshold;   // !< Busy threshold of the CCA energy. Not used in @ref NRF_RADIO_CCA_MODE_CARRIER. The threshold is absolute value in dBm.
     uint8_t              corr_threshold; // !< Busy threshold of the CCA correlator. Not used in @ref NRF_RADIO_CCA_MODE_ED.
     uint8_t              corr_limit;     // !< Limit of occurrences above the busy threshold of the CCA correlator. Not used in @ref NRF_RADIO_CCA_MODE_ED.
 } nrf_802154_cca_cfg_t;

drivers/nrf_802154/driver/src/mac_features/ack_generator/nrf_802154_enh_ack_generator.c

@@ -287,8 +287,8 @@ static uint8_t security_key_id_set(const nrf_802154_frame_parser_data_t * p_fram
 {
     const uint8_t * p_frame_key_id = nrf_802154_frame_parser_key_id_get(p_frame_data);
     uint8_t       * p_ack_key_id   = (uint8_t *)nrf_802154_frame_parser_key_id_get(p_ack_data);
-    uint8_t         key_id_size    = key_id_size_get(nrf_802154_frame_parser_sec_ctrl_key_id_mode_get(
-                                                         p_ack_data));
+    uint8_t         key_id_size    =
+        key_id_size_get(nrf_802154_frame_parser_sec_ctrl_key_id_mode_get(p_ack_data));
 
     if ((p_ack_key_id != NULL) && (p_frame_key_id != NULL))
     {
@@ -416,35 +416,6 @@ static void ie_header_set(const uint8_t                  * p_ie_data,
 #endif
 }
 
-static uint8_t ie_header_terminate(const uint8_t                  * p_ie_data,
-                                   uint8_t                          ie_data_len,
-                                   nrf_802154_frame_parser_data_t * p_ack_data)
-{
-    if (p_ie_data == NULL)
-    {
-        // No IEs to terminate.
-        return 0U;
-    }
-
-    if ((nrf_802154_frame_parser_security_enabled_bit_is_set(p_ack_data) == false) ||
-        (nrf_802154_frame_parser_sec_ctrl_sec_lvl_get(p_ack_data) == SECURITY_LEVEL_NONE))
-    {
-        // This code assumes that neither regular frame payload nor Payload IEs can be set by the
-        // driver. Therefore without security, the Ack has no payload, so termination is not necessary.
-        return 0U;
-    }
-
-    uint8_t * p_ack_ie = (uint8_t *)p_ack_data->p_frame + p_ack_data->helper.aux_sec_hdr_end_offset;
-    uint8_t   ie_hdr_term[IE_HEADER_SIZE];
-
-    NRF_802154_ASSERT(p_ack_ie != NULL);
-
-    host_16_to_little((IE_HT2) << IE_HEADER_ELEMENT_ID_OFFSET, ie_hdr_term);
-
-    memcpy(p_ack_ie + ie_data_len, ie_hdr_term, sizeof(ie_hdr_term));
-    return sizeof(ie_hdr_term);
-}
-
 /***************************************************************************************************
  * @section Authentication and encryption transformation
  **************************************************************************************************/
@@ -543,8 +514,8 @@ static void ie_process(const nrf_802154_frame_parser_data_t * p_frame_data)
     ie_header_set(mp_ie_data, m_ie_data_len, &m_ack_data);
     m_ack[PHR_OFFSET] += m_ie_data_len;
 
-    // Terminate the IE header if needed.
-    m_ack[PHR_OFFSET] += ie_header_terminate(mp_ie_data, m_ie_data_len, &m_ack_data) + FCS_SIZE;
+    // Add space for the FCS field.
+    m_ack[PHR_OFFSET] += FCS_SIZE;
 
     bool result = nrf_802154_frame_parser_valid_data_extend(&m_ack_data,
                                                             m_ack[PHR_OFFSET] + PHR_SIZE,

drivers/nrf_802154/driver/src/mac_features/nrf_802154_delayed_trx.c

@@ -46,6 +46,7 @@
 #include <stdbool.h>
 #include <stdint.h>
 
+#include <nrfx.h>
 #include "../nrf_802154_debug.h"
 #include "nrf_802154_config.h"
 #include "nrf_802154_const.h"
@@ -75,8 +76,10 @@
 #define TX_SETUP_TIME_MAX 360u ///< Maximum time needed to prepare TX procedure [us]. It does not include TX ramp-up time.
 #define RX_SETUP_TIME_MAX 290u ///< Maximum time needed to prepare RX procedure [us]. It does not include RX ramp-up time.
 #elif defined(NRF54L_SERIES)
-#define TX_SETUP_TIME_MAX 600u ///< Maximum time needed to prepare TX procedure [us]. It does not include TX ramp-up time.
-#define RX_SETUP_TIME_MAX 600u ///< Maximum time needed to prepare RX procedure [us]. It does not include RX ramp-up time.
+NRF_STATIC_ASSERT(NRF_CONFIG_CPU_FREQ_MHZ == 128,
+                  "Currently nrf-802154 only works when frequency is 128MHz");
+#define TX_SETUP_TIME_MAX 185u ///< Maximum time needed to prepare TX procedure [us]. It does not include TX ramp-up time.
+#define RX_SETUP_TIME_MAX 150u ///< Maximum time needed to prepare RX procedure [us]. It does not include RX ramp-up time.
 #elif defined(NRF54H_SERIES)
 #ifndef TX_SETUP_TIME_MAX
 #define TX_SETUP_TIME_MAX 400u ///< Maximum time needed to prepare TX procedure [us]. It does not include TX ramp-up time.
@@ -184,7 +187,7 @@ static dly_op_data_t * dly_rx_data_by_id_search(rsch_dly_ts_id_t id)
         if (m_dly_rx_data[i].id == id)
         {
             // Slot with a matching identifier found
-            if ((p_dly_op_data == NULL))
+            if (p_dly_op_data == NULL)
             {
                 // It's the first matching slot found
                 p_dly_op_data = &m_dly_rx_data[i];
@@ -795,9 +798,10 @@ bool nrf_802154_delayed_trx_transmit(uint8_t                                 * p
 
         p_dly_tx_data->tx.p_data             = p_data;
         p_dly_tx_data->tx.params.frame_props = p_metadata->frame_props;
-        (void)nrf_802154_tx_power_convert_metadata_to_tx_power_split(p_metadata->channel,
-                                                                     p_metadata->tx_power,
-                                                                     &p_dly_tx_data->tx.params.tx_power);
+        (void)nrf_802154_tx_power_convert_metadata_to_tx_power_split(
+            p_metadata->channel,
+            p_metadata->tx_power,
+            &p_dly_tx_data->tx.params.tx_power);
         p_dly_tx_data->tx.params.cca                = p_metadata->cca;
         p_dly_tx_data->tx.params.immediate          = true;
         p_dly_tx_data->tx.params.extra_cca_attempts = p_metadata->extra_cca_attempts;
@@ -918,6 +922,36 @@ bool nrf_802154_delayed_trx_receive_cancel(uint32_t id)
     return stopped;
 }
 
+bool nrf_802154_delayed_trx_receive_scheduled_cancel(uint32_t id)
+{
+    dly_op_data_t * p_dly_op_data = dly_rx_data_by_id_search(id);
+
+    if (p_dly_op_data == NULL)
+    {
+        // Delayed receive window with provided ID could not be found.
+        return true;
+    }
+
+    bool result = nrf_802154_rsch_delayed_timeslot_cancel(id, false);
+
+    if (!result)
+    {
+        result =
+            nrf_802154_sl_atomic_load_u8((uint8_t *)&p_dly_op_data->state) ==
+            DELAYED_TRX_OP_STATE_STOPPED;
+    }
+
+    if (result)
+    {
+        p_dly_op_data->id = NRF_802154_RESERVED_INVALID_ID;
+
+        nrf_802154_sl_atomic_store_u8((uint8_t *)&p_dly_op_data->state,
+                                      DELAYED_TRX_OP_STATE_STOPPED);
+    }
+
+    return result;
+}
+
 bool nrf_802154_delayed_trx_abort(nrf_802154_term_t term_lvl, req_originator_t req_orig)
 {
     nrf_802154_log_function_enter(NRF_802154_LOG_VERBOSITY_HIGH);

drivers/nrf_802154/driver/src/mac_features/nrf_802154_delayed_trx.h

@@ -137,6 +137,22 @@ bool nrf_802154_delayed_trx_receive(uint64_t rx_time,
  */
 bool nrf_802154_delayed_trx_receive_cancel(uint32_t id);
 
+/**
+ * @brief Cancels a scheduled reception scheduled by a call to @ref nrf_802154_delayed_trx_receive.
+ *
+ * If the receive window is currently ongoing, it will not be affected and a timeout event will
+ * be notified at scheduled time.
+ *
+ * @param[in]  id  Identifier of the delayed reception window to be cancelled. If the provided
+ *                 value does not refer to any scheduled or active receive window, the function
+ *                 returns true.
+ *
+ * @retval true     Successfully cancelled a scheduled transmission or no window
+ *                  with given ID is scheduled.
+ * @retval false    The receive window is currently ongoing.
+ */
+bool nrf_802154_delayed_trx_receive_scheduled_cancel(uint32_t id);
+
 /**
  * @brief Aborts an ongoing delayed reception procedure.
  *

drivers/nrf_802154/driver/src/mac_features/nrf_802154_filter.c

@@ -337,19 +337,20 @@ static bool dst_pan_id_check(const uint8_t * p_panid, uint8_t frame_type)
  */
 static bool dst_short_addr_check(const uint8_t * p_dst_addr)
 {
-    bool result;
-
     if ((0 == memcmp(p_dst_addr, nrf_802154_pib_short_address_get(), SHORT_ADDRESS_SIZE)) ||
         (0 == memcmp(p_dst_addr, BROADCAST_ADDRESS, SHORT_ADDRESS_SIZE)))
     {
-        result = true;
+        return true;
     }
-    else
+
+    const uint8_t * alternate_address = nrf_802154_pib_alternate_short_address_get();
+
+    if (alternate_address && (0 == memcmp(p_dst_addr, alternate_address, SHORT_ADDRESS_SIZE)))
     {
-        result = false;
+        return true;
     }
 
-    return result;
+    return false;
 }
 
 /**

drivers/nrf_802154/driver/src/mac_features/nrf_802154_frame_parser.c

@@ -305,6 +305,7 @@ static bool sec_ctrl_parse(nrf_802154_frame_parser_data_t * p_parser_data)
     if (nrf_802154_frame_parser_security_enabled_bit_is_set(p_parser_data) == false)
     {
         p_parser_data->helper.aux_sec_hdr_end_offset = offset;
+        p_parser_data->helper.mic_size               = 0;
         return true;
     }
 
@@ -515,9 +516,10 @@ bool nrf_802154_frame_parser_data_init(const uint8_t                  * p_frame,
     return parse_state_advance(p_parser_data, requested_parse_level);
 }
 
-bool nrf_802154_frame_parser_valid_data_extend(nrf_802154_frame_parser_data_t * p_parser_data,
-                                               uint8_t                          valid_data_len,
-                                               nrf_802154_frame_parser_level_t  requested_parse_level)
+bool nrf_802154_frame_parser_valid_data_extend(
+    nrf_802154_frame_parser_data_t * p_parser_data,
+    uint8_t                          valid_data_len,
+    nrf_802154_frame_parser_level_t  requested_parse_level)
 {
     if (valid_data_len > p_parser_data->valid_data_len)
     {