Skip to content

Update revision of nrf_802154 #2064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlubos merged 1 commit into from
Apr 3, 2026
Merged

Update revision of nrf_802154 #2064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
382 changes: 191 additions & 191 deletions nrf_802154/common/include/nrf_802154_const.h
View file
Open in desktop

Large diffs are not rendered by default.

309 changes: 149 additions & 160 deletions nrf_802154/common/include/nrf_802154_types.h
View file
Open in desktop

Large diffs are not rendered by default.

69 changes: 35 additions & 34 deletions nrf_802154/driver/src/mac_features/ack_generator/nrf_802154_ack_data.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,52 +48,52 @@
#include "nrf_802154_config.h"
#include "nrf_802154_const.h"

/// Maximum number of Short Addresses of nodes for which there is ACK data to set.
/** Maximum number of Short Addresses of nodes for which there is ACK data to set. */
#define NUM_SHORT_ADDRESSES NRF_802154_PENDING_SHORT_ADDRESSES
/// Maximum number of Extended Addresses of nodes for which there is ACK data to set.
/** Maximum number of Extended Addresses of nodes for which there is ACK data to set. */
#define NUM_EXTENDED_ADDRESSES NRF_802154_PENDING_EXTENDED_ADDRESSES

/// Structure representing pending bit setting variables.
/** Structure representing pending bit setting variables. */
typedef struct
{
bool enabled; /// If setting pending bit is enabled.
uint8_t short_addr[NUM_SHORT_ADDRESSES][SHORT_ADDRESS_SIZE]; /// Array of short addresses of nodes for which there is pending data in the buffer.
uint8_t extended_addr[NUM_EXTENDED_ADDRESSES][EXTENDED_ADDRESS_SIZE]; /// Array of extended addresses of nodes for which there is pending data in the buffer.
uint32_t num_of_short_addr; /// Current number of short addresses of nodes for which there is pending data in the buffer.
uint32_t num_of_ext_addr; /// Current number of extended addresses of nodes for which there is pending data in the buffer.
bool enabled; /**< If setting pending bit is enabled. */
uint8_t short_addr[NUM_SHORT_ADDRESSES][SHORT_ADDRESS_SIZE]; /**< Array of short addresses of nodes for which there is pending data in the buffer. */
uint8_t extended_addr[NUM_EXTENDED_ADDRESSES][EXTENDED_ADDRESS_SIZE]; /**< Array of extended addresses of nodes for which there is pending data in the buffer. */
uint32_t num_of_short_addr; /**< Current number of short addresses of nodes for which there is pending data in the buffer. */
uint32_t num_of_ext_addr; /**< Current number of extended addresses of nodes for which there is pending data in the buffer. */
} pending_bit_arrays_t;

// Structure representing a single IE record.
/* Structure representing a single IE record. */
typedef struct
{
uint8_t p_data[NRF_802154_MAX_ACK_IE_SIZE]; /// Pointer to IE data buffer.
uint8_t len; /// Length of the buffer.
uint8_t p_data[NRF_802154_MAX_ACK_IE_SIZE]; /**< Pointer to IE data buffer. */
uint8_t len; /**< Length of the buffer. */
} ie_data_t;

// Structure representing IE records sent in an ACK message to a given short address.
/* Structure representing IE records sent in an ACK message to a given short address. */
typedef struct
{
uint8_t addr[SHORT_ADDRESS_SIZE]; /// Short address of peer node.
ie_data_t ie_data; /// Pointer to IE records.
uint8_t addr[SHORT_ADDRESS_SIZE]; /**< Short address of peer node. */
ie_data_t ie_data; /**< Pointer to IE records. */
} ack_short_ie_data_t;

// Structure representing IE records sent in an ACK message to a given extended address.
/* Structure representing IE records sent in an ACK message to a given extended address. */
typedef struct
{
uint8_t addr[EXTENDED_ADDRESS_SIZE]; /// Extended address of peer node.
ie_data_t ie_data; /// Pointer to IE records.
uint8_t addr[EXTENDED_ADDRESS_SIZE]; /**< Extended address of peer node. */
ie_data_t ie_data; /**< Pointer to IE records. */
} ack_ext_ie_data_t;

// Structure representing IE data setting variables.
/* Structure representing IE data setting variables. */
typedef struct
{
ack_short_ie_data_t short_data[NUM_SHORT_ADDRESSES]; /// Array of short addresses and IE records sent to these addresses.
ack_ext_ie_data_t ext_data[NUM_EXTENDED_ADDRESSES]; /// Array of extended addresses and IE records sent to these addresses.
uint32_t num_of_short_data; /// Current number of short addresses stored in @p short_data.
uint32_t num_of_ext_data; /// Current number of extended addresses stored in @p ext_data.
ack_short_ie_data_t short_data[NUM_SHORT_ADDRESSES]; /**< Array of short addresses and IE records sent to these addresses. */
ack_ext_ie_data_t ext_data[NUM_EXTENDED_ADDRESSES]; /**< Array of extended addresses and IE records sent to these addresses. */
uint32_t num_of_short_data; /**< Current number of short addresses stored in @p short_data. */
uint32_t num_of_ext_data; /**< Current number of extended addresses stored in @p ext_data. */
} ie_arrays_t;

// TODO: Combine below arrays to perform binary search only once per Ack generation.
/* TODO: Combine below arrays to perform binary search only once per ACK generation. */
static pending_bit_arrays_t m_pending_bit;
static ie_arrays_t m_ie;
static nrf_802154_src_addr_match_t m_src_matching_method;
Expand All @@ -117,7 +117,7 @@ static int8_t extended_addr_compare(const uint8_t * p_first_addr, const uint8_t
uint32_t first_addr;
uint32_t second_addr;

// Compare extended address in two steps to prevent unaligned access error.
/* Compare extended address in two steps to prevent unaligned access error. */
for (uint32_t i = 0; i < EXTENDED_ADDRESS_SIZE / sizeof(uint32_t); i++)
{
first_addr = *(const uint32_t *)(p_first_addr + (i * sizeof(uint32_t)));
Expand Down Expand Up @@ -230,7 +230,7 @@ static bool addr_binary_search(const uint8_t * p_addr,
break;
}

// The actual algorithm
/* The actual algorithm */
int32_t low = 0;
uint32_t midpoint = 0;
int32_t high = addr_array_len;
Expand Down Expand Up @@ -270,7 +270,8 @@ static bool addr_binary_search(const uint8_t * p_addr,
* last iteration, midpoint is equal to 1 and low and high are equal to 0. Midpoint is then set
* to 0 and with last case being utilized, low is set to 1. However, midpoint equal to 0 is
* incorrect, as in the last iteration first element of the array proves to be less than the
* element to be added to the array. With the below code, midpoint is then shifted to 1. */
* element to be added to the array. With the below code, midpoint is then shifted to 1.
*/
if ((uint32_t)low == midpoint + 1)
{
midpoint++;
Expand Down Expand Up @@ -339,7 +340,7 @@ static bool addr_match_thread(const nrf_802154_frame_t * 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.
/* The pending bit is set by default. */
if (!m_pending_bit.enabled || (NULL == p_src_addr))
{
return true;
Expand All @@ -364,25 +365,25 @@ static bool addr_match_zigbee(const nrf_802154_frame_t * p_frame_data)
const uint8_t * p_src_addr;
bool ret = false;

// If ack data generator module is disabled do not perform check, return true by default.
/* If ack data generator module is disabled do not perform check, return true by default. */
if (!m_pending_bit.enabled)
{
return true;
}

// Check the frame type.
/* Check the frame type. */
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_mac_command_id_get(p_frame_data);

// Check frame type and command type.
/* Check frame type and command type. */
if ((p_cmd != NULL) && (*p_cmd == MAC_CMD_DATA_REQ))
{
// Check addressing type - in long case address, pb should always be 1.
/* Check addressing type - in long case address, pb should always be 1. */
if (src_addr_type == SRC_ADDR_TYPE_SHORT)
{
// Return true if address is not found on the m_pending_bits list.
/* Return true if address is not found on the m_pending_bits list. */
ret = !addr_index_find(p_src_addr,
&location,
NRF_802154_ACK_DATA_PENDING_BIT,
Expand Down Expand Up @@ -494,7 +495,8 @@ static bool addr_add(const uint8_t * p_addr,
if (data_type == NRF_802154_ACK_DATA_IE)
{
/* The content of ie_data_t in the structure indexed by location
* is uninitialized (can have old content). Let's initialize it. */
* is uninitialized (can have old content). Let's initialize it.
*/
ie_data_t * p_ie_data = extended ?
&(((ack_ext_ie_data_t *)p_entry_at_location)->ie_data) :
&(((ack_short_ie_data_t *)p_entry_at_location)->ie_data);
Expand Down Expand Up @@ -619,7 +621,6 @@ static bool ie_data_set(uint32_t location, bool extended, const uint8_t * p_data
}

/* Append IE data with the new IE. */

if (ie_data->len + data_len > NRF_802154_MAX_ACK_IE_SIZE)
{
/* No space to fit it the new IE. */
Expand Down
14 changes: 7 additions & 7 deletions nrf_802154/driver/src/mac_features/ack_generator/nrf_802154_ack_data.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
#include "mac_features/nrf_802154_frame.h"

/**
* @brief Initializes the ACK data generator module.
* @brief Initialize the ACK data generator module.
*/
void nrf_802154_ack_data_init(void);

Expand All @@ -60,7 +60,7 @@ void nrf_802154_ack_data_init(void);
void nrf_802154_ack_data_enable(bool enabled);

/**
* @brief Adds an address to the ACK data list.
* @brief Add an address to the ACK data list.
*
* ACK frames sent in response to frames with the source address matching any address from the ACK data list
* will have the appropriate data set. If the source address does not match any of the addresses in the
Expand All @@ -82,7 +82,7 @@ bool nrf_802154_ack_data_for_addr_set(const uint8_t * p_addr,
uint8_t data_len);

/**
* @brief Removes an address from the ACK data list.
* @brief Remove an address from the ACK data list.
*
* ACK frames sent in response to frames with the source address matching any address from
* the ACK data list will have the appropriate data set. If the source address does not match
Expand All @@ -100,7 +100,7 @@ bool nrf_802154_ack_data_for_addr_clear(const uint8_t * p_addr,
nrf_802154_ack_data_t data_type);

/**
* @brief Removes all addresses of a given length from the ACK data list.
* @brief Remove all addresses of a given length from the ACK data list.
*
* @param[in] extended Indication if all extended addresses or all short addresses are
* to be removed from the list.
Expand All @@ -122,7 +122,7 @@ void nrf_802154_ack_data_reset(bool extended, nrf_802154_ack_data_t data_type);
void nrf_802154_ack_data_src_addr_matching_method_set(nrf_802154_src_addr_match_t match_method);

/**
* @brief Checks if a pending bit is to be set in the ACK frame sent in response to a given frame.
* @brief Check if a pending bit is to be set in the ACK frame sent in response to a given frame.
*
* @param[in] p_frame_data Pointer to the frame parser data for which the ACK frame is being prepared.
*
Expand All @@ -133,7 +133,7 @@ bool nrf_802154_ack_data_pending_bit_should_be_set(
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.
* @brief Get the IE data stored in the list for the source address of the provided frame.
*
* @param[in] p_src_addr Pointer to the source address to search for in the list.
* @param[in] src_addr_ext If the source address is extended.
Expand All @@ -145,4 +145,4 @@ const uint8_t * nrf_802154_ack_data_ie_get(const uint8_t * p_src_addr,
bool src_addr_ext,
uint8_t * p_ie_length);

#endif // NRF_802154_ACK_DATA_H
#endif /* NRF_802154_ACK_DATA_H */
6 changes: 3 additions & 3 deletions nrf_802154/driver/src/mac_features/ack_generator/nrf_802154_ack_generator.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,21 +72,21 @@ static frame_version_t frame_version_is_2015_or_above(

void nrf_802154_ack_generator_init(void)
{
// Both generators are initialized to enable sending both Imm-Acks and Enh-Acks.
/* Both generators are initialized to enable sending both Imm-Acks and Enh-Acks. */
nrf_802154_imm_ack_generator_init();
nrf_802154_enh_ack_generator_init();
}

void nrf_802154_ack_generator_reset(void)
{
// Both generators are reset to enable sending both Imm-Ack and Enh-Ack.
/* Both generators are reset to enable sending both Imm-Ack and Enh-Ack. */
nrf_802154_imm_ack_generator_reset();
nrf_802154_enh_ack_generator_reset();
}

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.
/* This function should not be called if ACK is not requested. */
NRF_802154_ASSERT(nrf_802154_frame_ar_bit_is_set(p_frame_data));

switch (frame_version_is_2015_or_above(p_frame_data))
Expand Down
15 changes: 9 additions & 6 deletions nrf_802154/driver/src/mac_features/ack_generator/nrf_802154_ack_generator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,21 @@

#include "mac_features/nrf_802154_frame.h"

/** Initializes the ACK generator module. */
/**
* @brief Initialize the ACK generator module.
*/
void nrf_802154_ack_generator_init(void);

/** @brief Resets the ACK generator module.
/**
* @brief Reset the ACK generator module.
*
* @note This function should be called for every received frame to be acknowledged before
* @ref nrf_802154_ack_generator_create is called for that frame.
*/
void nrf_802154_ack_generator_reset(void);

/** @brief Creates an ACK in response to the provided frame and inserts it into a radio buffer.
/**
* @brief Create an ACK in response to the provided frame and insert it into a radio buffer.
*
* @note Only those contents of the frame being acknowledged marked by @p p_frame_data as valid
* are used for ACK generation. If any data necessary to generate an ACK is missing or marked as
Expand All @@ -68,7 +72,6 @@ void nrf_802154_ack_generator_reset(void);
* @returns Either pointer to a constant buffer that contains PHR and PSDU
* of the created ACK frame, or NULL when the response cannot be created.
*/
uint8_t * nrf_802154_ack_generator_create(
const nrf_802154_frame_t * p_frame_data);
uint8_t * nrf_802154_ack_generator_create(const nrf_802154_frame_t * p_frame_data);

#endif // NRF_802154_ACK_GENERATOR_H
#endif /* NRF_802154_ACK_GENERATOR_H */
Loading
Loading