drivers: nrf_802154: Update the IEEE 802.15.4 component

This commit updates the nRF 802.15.4 radio driver to feature the latest
changes.

sdk-nrf-802154 commit: 8fa87173f1a314ce4de0a307999de3fb32979c7a

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

Author: e-rk

drivers/nrf_802154/common/include/nrf_802154.h

@@ -514,6 +514,10 @@ bool nrf_802154_receive_at_scheduled_cancel(uint32_t id);
  * @note This function is implemented in zero-copy fashion. It passes the given buffer pointer to
  *       the RADIO peripheral.
  *
+ * @note Setting @p tx_timestamp_encode to true is only allowed if
+ *       @ref NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED is enabled.
+ *       If this condition is not met, any attempt to transmit a frame will fail unconditionally.
+ *
  * In the transmit state, the radio transmits a given frame. If requested, it waits for
  * an ACK frame. Depending on @ref NRF_802154_ACK_TIMEOUT_ENABLED, the radio driver automatically
  * stops waiting for an ACK frame or waits indefinitely for an ACK frame. If it is configured to
@@ -542,6 +546,7 @@ bool nrf_802154_receive_at_scheduled_cancel(uint32_t id);
  *                         ----------------|-----------------------------------------------------
  *                         @c frame_props  | @ref NRF_802154_TRANSMITTED_FRAME_PROPS_DEFAULT_INIT
  *                         @c cca          | @c true
+ *                         @c tx_timestamp_encode | @c false
  *
  * @retval  true   The transmission procedure was scheduled.
  * @retval  false  The driver could not schedule the transmission procedure.
@@ -602,6 +607,10 @@ bool nrf_802154_transmit_raw(uint8_t                              * p_data,
  * A successfully scheduled transmission can be cancelled by a call
  * to @ref nrf_802154_transmit_at_cancel.
  *
+ * @note Setting @p tx_timestamp_encode to true is only allowed if
+ *       @ref NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED is enabled.
+ *       If this condition is not met, any attempt to transmit a frame will fail unconditionally.
+ *
  * @param[in]  p_data      Pointer to the array with data to transmit. The first byte must contain
  *                         the frame length (including FCS). The following bytes contain data.
  *                         The CRC is computed automatically by the radio hardware. Therefore,
@@ -616,6 +625,7 @@ bool nrf_802154_transmit_raw(uint8_t                              * p_data,
  *                         @c channel            | As returned by @ref nrf_802154_channel_get
  *                         @c tx_power           | As set with @ref nrf_802154_tx_power_set
  *                         @c extra_cca_attempts | @c 0
+ *                         @c tx_timestamp_encode | @c 0
  *
  * @retval  true   The transmission procedure was scheduled.
  * @retval  false  The driver could not schedule the transmission procedure.
@@ -1063,13 +1073,17 @@ void nrf_802154_cca_cfg_get(nrf_802154_cca_cfg_t * p_cca_cfg);
  *       the CSMA-CA procedure does not time out waiting for an ACK frame if a frame
  *       with the ACK request bit set was transmitted.
  * @note This function is available if @ref NRF_802154_CSMA_CA_ENABLED is enabled.
+ * @note Setting @p tx_timestamp_encode to true is only allowed if
+ *       @ref NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED is enabled.
+ *       If this condition is not met, any attempt to transmit a frame will fail unconditionally.
  *
  * @param[in]  p_data      Pointer to the frame to transmit. See also @ref nrf_802154_transmit_raw.
  * @param[in]  p_metadata  Pointer to metadata structure. Contains detailed properties of data
  *                         to transmit. If @c NULL following metadata are used:
  *                         Field           | Value
  *                         ----------------|-----------------------------------------------------
  *                         @c frame_props  | @ref NRF_802154_TRANSMITTED_FRAME_PROPS_DEFAULT_INIT
+ *                         @c tx_timestamp_encode | false
  *
  * @retval  true   The chain of CSMA-CA and transmission procedure was scheduled.
  * @retval  false  The driver could not schedule the procedure chain.

drivers/nrf_802154/common/include/nrf_802154_config.h

@@ -595,6 +595,54 @@ extern "C" {
 #define NRF_802154_REQUEST_IMPL NRF_802154_REQUEST_IMPL_SWI
 #endif
 
+/**
+ * @}
+ * @defgroup nrf_802154_tx_timestamp_provider Transmit Timestamp configuration
+ * @{
+ */
+
+/**
+ * @def NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED
+ *
+ * Enables the Transmit Timestamp Provider module. The module encodes the transmission
+ * start timestamp in a frame's payload upon request.
+ */
+#ifndef NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED
+#define NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED 0
+#endif
+
+/**
+ * @}
+ * @defgroup nrf_802154_tx_misc Miscellaneous options
+ * @{
+ */
+
+/**
+ * @def NRF_802154_TX_DIAGNOSTIC_MODE
+ *
+ * Disables strict frame validation.
+ *
+ * When this option is disabled the nRF 802.154 Radio Driver performs strict frame format
+ * validation of any frame that is to be transmitted. Frames that do not conform
+ * the IEEE 802.15.4 MAC frame format will be discarded on transmit attempts.
+ *
+ * When this option is enabled the validation of frame format is disabled what allows for
+ * sending arbitrary frames. The functionality set of the radio driver is reduced.
+ * The IE writer, security writer, encryption, and TX timestamp modules cannot be used.
+ */
+#ifndef NRF_802154_TX_DIAGNOSTIC_MODE
+#define NRF_802154_TX_DIAGNOSTIC_MODE 0
+#endif
+
+#if NRF_802154_TX_DIAGNOSTIC_MODE
+#if NRF_802154_IE_WRITER_ENABLED || \
+    NRF_802154_SECURITY_WRITER_ENABLED || \
+    NRF_802154_ENCRYPTION_ENABLED || \
+    NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED
+#error "TX Diagnostic mode is not compatible with IE writer, Security writer, Encryption, and TX timestamp."
+#endif
+#endif
+
 /** @} */
 
 /**

drivers/nrf_802154/common/include/nrf_802154_types.h

@@ -81,16 +81,17 @@ typedef uint8_t nrf_802154_state_t;
  */
 typedef uint8_t nrf_802154_tx_error_t;
 
-#define NRF_802154_TX_ERROR_NONE                0x00 // !< There is no transmit error.
-#define NRF_802154_TX_ERROR_BUSY_CHANNEL        0x01 // !< CCA reported busy channel before the transmission.
-#define NRF_802154_TX_ERROR_INVALID_ACK         0x02 // !< Received ACK frame is other than expected.
-#define NRF_802154_TX_ERROR_NO_MEM              0x03 // !< No receive buffer is available to receive an ACK.
-#define NRF_802154_TX_ERROR_TIMESLOT_ENDED      0x04 // !< Radio timeslot ended during the transmission procedure.
-#define NRF_802154_TX_ERROR_NO_ACK              0x05 // !< ACK frame was not received during the timeout period.
-#define NRF_802154_TX_ERROR_ABORTED             0x06 // !< Procedure was aborted by another operation.
-#define NRF_802154_TX_ERROR_TIMESLOT_DENIED     0x07 // !< Transmission did not start due to a denied timeslot request.
-#define NRF_802154_TX_ERROR_KEY_ID_INVALID      0x08 // !< Transmission did not start due to invalid key ID in frame's security header.
-#define NRF_802154_TX_ERROR_FRAME_COUNTER_ERROR 0x09 // !< Transmission did not start due a frame counter error.
+#define NRF_802154_TX_ERROR_NONE                     0x00 // !< There is no transmit error.
+#define NRF_802154_TX_ERROR_BUSY_CHANNEL             0x01 // !< CCA reported busy channel before the transmission.
+#define NRF_802154_TX_ERROR_INVALID_ACK              0x02 // !< Received ACK frame is other than expected.
+#define NRF_802154_TX_ERROR_NO_MEM                   0x03 // !< No receive buffer is available to receive an ACK.
+#define NRF_802154_TX_ERROR_TIMESLOT_ENDED           0x04 // !< Radio timeslot ended during the transmission procedure.
+#define NRF_802154_TX_ERROR_NO_ACK                   0x05 // !< ACK frame was not received during the timeout period.
+#define NRF_802154_TX_ERROR_ABORTED                  0x06 // !< Procedure was aborted by another operation.
+#define NRF_802154_TX_ERROR_TIMESLOT_DENIED          0x07 // !< Transmission did not start due to a denied timeslot request.
+#define NRF_802154_TX_ERROR_KEY_ID_INVALID           0x08 // !< Transmission did not start due to invalid key ID in frame's security header.
+#define NRF_802154_TX_ERROR_FRAME_COUNTER_ERROR      0x09 // !< Transmission did not start due a frame counter error.
+#define NRF_802154_TX_ERROR_TIMESTAMP_ENCODING_ERROR 0x0A // !< Timestamp could not been encoded in the transmission process.
 
 /**
  * @brief Possible errors during the frame reception.
@@ -442,6 +443,7 @@ typedef struct
     bool                                 cca;         // !< If the driver is to perform a CCA procedure before transmission.
     nrf_802154_tx_power_metadata_t       tx_power;    // !< Information about the TX power to be used.
     nrf_802154_tx_channel_metadata_t     tx_channel;  // !< Information about the TX channel to be used.
+    bool                                 tx_timestamp_encode; // !< True if the transmit timestamp shall be encoded in the payload.
 } nrf_802154_transmit_metadata_t;
 
 /**
@@ -454,6 +456,7 @@ typedef struct
     uint8_t                              channel;            // !< Radio channel on which the frame is to be transmitted.
     nrf_802154_tx_power_metadata_t       tx_power;           // !< Information about the TX power to be used.
     uint8_t                              extra_cca_attempts; // !< Maximum number of additional CCA attempts that can be performed if the first attempt returns busy channel. Ignored if @ref cca equals @c false.
+    bool                                 tx_timestamp_encode; // !< True if the transmit timestamp shall be encoded in the payload.
 } nrf_802154_transmit_at_metadata_t;
 
 /**
@@ -464,6 +467,7 @@ typedef struct
     nrf_802154_transmitted_frame_props_t frame_props; // !< Properties of the frame to be transmitted.
     nrf_802154_tx_power_metadata_t       tx_power;    // !< Information about the TX power to be used.
     nrf_802154_tx_channel_metadata_t     tx_channel;  // !< Information about the TX channel to be used.
+    bool                                 tx_timestamp_encode; // !< True if the transmit timestamp shall be encoded in the payload.
 } nrf_802154_transmit_csma_ca_metadata_t;
 
 /**
@@ -489,14 +493,6 @@ typedef struct
     } data;                  // !< Result values that are valid only for successful operations.
 } nrf_802154_transmit_done_metadata_t;
 
-/**
- * @brief Function pointer used for notifying about transmission failure.
- */
-typedef void (* nrf_802154_transmit_failed_notification_t)(
-    uint8_t                                   * p_frame,
-    nrf_802154_tx_error_t                       error,
-    const nrf_802154_transmit_done_metadata_t * p_meta);
-
 /**
  * @brief Structure that holds results of energy detection procedure.
  */

drivers/nrf_802154/driver/CMakeLists.txt

@@ -74,10 +74,11 @@ target_sources(nrf-802154-driver
     src/mac_features/nrf_802154_filter.c
     src/mac_features/nrf_802154_frame_parser.c
     src/mac_features/nrf_802154_ie_writer.c
-    src/mac_features/nrf_802154_ifs.c
+    src/mac_features/nrf_802154_imm_tx.c
     src/mac_features/nrf_802154_security_pib_ram.c
     src/mac_features/nrf_802154_security_writer.c
     src/mac_features/nrf_802154_precise_ack_timeout.c
+    src/mac_features/nrf_802154_tx_timestamp_provider.c
     src/mac_features/ack_generator/nrf_802154_ack_data.c
     src/mac_features/ack_generator/nrf_802154_ack_generator.c
     src/mac_features/ack_generator/nrf_802154_enh_ack_generator.c

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

@@ -44,7 +44,7 @@
 #include "nrf_802154_assert.h"
 #include <string.h>
 
-#include "mac_features/nrf_802154_frame_parser.h"
+#include "mac_features/nrf_802154_frame.h"
 #include "nrf_802154_config.h"
 #include "nrf_802154_const.h"
 
@@ -333,11 +333,11 @@ static bool addr_index_find(const uint8_t       * p_addr,
  * @retval true   Pending bit is to be set.
  * @retval false  Pending bit is to be cleared.
  */
-static bool addr_match_thread(const nrf_802154_frame_parser_data_t * p_frame_data)
+static bool addr_match_thread(const nrf_802154_frame_t * p_frame_data)
 {
     uint32_t        location;
-    bool            extended   = nrf_802154_frame_parser_src_addr_is_extended(p_frame_data);
-    const uint8_t * p_src_addr = nrf_802154_frame_parser_src_addr_get(p_frame_data);
+    bool            extended   = nrf_802154_frame_src_addr_is_extended(p_frame_data);
+    const uint8_t * p_src_addr = nrf_802154_frame_src_addr_get(p_frame_data);
 
     // The pending bit is set by default.
     if (!m_pending_bit.enabled || (NULL == p_src_addr))
@@ -356,7 +356,7 @@ static bool addr_match_thread(const nrf_802154_frame_parser_data_t * p_frame_dat
  * @retval true   Pending bit is to be set.
  * @retval false  Pending bit is to be cleared.
  */
-static bool addr_match_zigbee(const nrf_802154_frame_parser_data_t * p_frame_data)
+static bool addr_match_zigbee(const nrf_802154_frame_t * p_frame_data)
 {
     uint8_t         src_addr_type;
     uint32_t        location;
@@ -371,10 +371,10 @@ static bool addr_match_zigbee(const nrf_802154_frame_parser_data_t * p_frame_dat
     }
 
     // Check the frame type.
-    p_src_addr    = nrf_802154_frame_parser_src_addr_get(p_frame_data);
-    src_addr_type = nrf_802154_frame_parser_src_addr_type_get(p_frame_data);
+    p_src_addr    = nrf_802154_frame_src_addr_get(p_frame_data);
+    src_addr_type = nrf_802154_frame_src_addr_type_get(p_frame_data);
 
-    p_cmd = nrf_802154_frame_parser_mac_command_id_get(p_frame_data);
+    p_cmd = nrf_802154_frame_mac_command_id_get(p_frame_data);
 
     // Check frame type and command type.
     if ((p_cmd != NULL) && (*p_cmd == MAC_CMD_DATA_REQ))
@@ -407,7 +407,7 @@ static bool addr_match_zigbee(const nrf_802154_frame_parser_data_t * p_frame_dat
  *
  * @retval true   Pending bit is to be set.
  */
-static bool addr_match_standard_compliant(const nrf_802154_frame_parser_data_t * p_frame_data)
+static bool addr_match_standard_compliant(const nrf_802154_frame_t * p_frame_data)
 {
     (void)p_frame_data;
     return true;
@@ -597,18 +597,18 @@ static bool ie_data_set(uint32_t location, bool extended, const uint8_t * p_data
     ie_data_t * ie_data =
         extended ? &m_ie.ext_data[location].ie_data : &m_ie.short_data[location].ie_data;
 
-    const uint8_t new_ie_id = nrf_802154_frame_parser_ie_id_get(p_data);
+    const uint8_t new_ie_id = nrf_802154_frame_ie_id_get(p_data);
 
-    for (const uint8_t * ie = nrf_802154_frame_parser_header_ie_iterator_begin(ie_data->p_data);
-         nrf_802154_frame_parser_ie_iterator_end(ie, ie_data->p_data + ie_data->len) == false;
-         ie = nrf_802154_frame_parser_ie_iterator_next(ie))
+    for (const uint8_t * ie = nrf_802154_frame_header_ie_iterator_begin(ie_data->p_data);
+         nrf_802154_frame_ie_iterator_end(ie, ie_data->p_data + ie_data->len) == false;
+         ie = nrf_802154_frame_ie_iterator_next(ie))
     {
-        if (nrf_802154_frame_parser_ie_id_get(ie) != new_ie_id)
+        if (nrf_802154_frame_ie_id_get(ie) != new_ie_id)
         {
             continue;
         }
 
-        if (IE_DATA_OFFSET + nrf_802154_frame_parser_ie_length_get(ie) != data_len)
+        if (IE_DATA_OFFSET + nrf_802154_frame_ie_length_get(ie) != data_len)
         {
             /* Overwriting an existing IE with a different size is not supported. */
             return false;
@@ -738,7 +738,7 @@ void nrf_802154_ack_data_src_addr_matching_method_set(nrf_802154_src_addr_match_
 }
 
 bool nrf_802154_ack_data_pending_bit_should_be_set(
-    const nrf_802154_frame_parser_data_t * p_frame_data)
+    const nrf_802154_frame_t * p_frame_data)
 {
     bool ret;
 

drivers/nrf_802154/driver/src/mac_features/ack_generator/nrf_802154_ack_data.h

@@ -45,7 +45,7 @@
 #include <stdint.h>
 
 #include "nrf_802154_types.h"
-#include "mac_features/nrf_802154_frame_parser.h"
+#include "mac_features/nrf_802154_frame.h"
 
 /**
  * @brief Initializes the ACK data generator module.
@@ -130,7 +130,7 @@ void nrf_802154_ack_data_src_addr_matching_method_set(nrf_802154_src_addr_match_
  * @retval false  Pending bit is to be cleared.
  */
 bool nrf_802154_ack_data_pending_bit_should_be_set(
-    const nrf_802154_frame_parser_data_t * p_frame_data);
+    const nrf_802154_frame_t * p_frame_data);
 
 /**
  * @brief Gets the IE data stored in the list for the source address of the provided frame.

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

@@ -54,9 +54,9 @@ typedef enum
 } frame_version_t;
 
 static frame_version_t frame_version_is_2015_or_above(
-    const nrf_802154_frame_parser_data_t * p_frame_data)
+    const nrf_802154_frame_t * p_frame_data)
 {
-    switch (nrf_802154_frame_parser_frame_version_get(p_frame_data))
+    switch (nrf_802154_frame_version_get(p_frame_data))
     {
         case FRAME_VERSION_0:
         case FRAME_VERSION_1:
@@ -84,10 +84,10 @@ void nrf_802154_ack_generator_reset(void)
     nrf_802154_enh_ack_generator_reset();
 }
 
-uint8_t * nrf_802154_ack_generator_create(const nrf_802154_frame_parser_data_t * p_frame_data)
+uint8_t * nrf_802154_ack_generator_create(const nrf_802154_frame_t * p_frame_data)
 {
     // This function should not be called if ACK is not requested.
-    NRF_802154_ASSERT(nrf_802154_frame_parser_ar_bit_is_set(p_frame_data));
+    NRF_802154_ASSERT(nrf_802154_frame_ar_bit_is_set(p_frame_data));
 
     switch (frame_version_is_2015_or_above(p_frame_data))
     {

drivers/nrf_802154/driver/src/mac_features/ack_generator/nrf_802154_ack_generator.h

@@ -42,7 +42,7 @@
 
 #include <stdint.h>
 
-#include "mac_features/nrf_802154_frame_parser.h"
+#include "mac_features/nrf_802154_frame.h"
 
 /** Initializes the ACK generator module. */
 void nrf_802154_ack_generator_init(void);
@@ -69,6 +69,6 @@ void nrf_802154_ack_generator_reset(void);
  *           of the created ACK frame, or NULL when the response cannot be created.
  */
 uint8_t * nrf_802154_ack_generator_create(
-    const nrf_802154_frame_parser_data_t * p_frame_data);
+    const nrf_802154_frame_t * p_frame_data);
 
 #endif // NRF_802154_ACK_GENERATOR_H