Skip to content

Commit fcbe493

Browse files
chshuchshu
committed
Merge branch 'feature/add_txrx_frame_dump_debugging' into 'master'
feat(802.15.4): supported tx/rx frame dumping See merge request espressif/esp-idf!37983
2 parents ccd9987 + d6996bd commit fcbe493

File tree

5 files changed

+166
-20
lines changed

5 files changed

+166
-20
lines changed

‎components/ieee802154/Kconfig‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,26 @@ menu "IEEE 802.15.4"
181181
help
182182
set the record abort table size
183183

184+
config IEEE802154_RECORD_TXRX_FRAME
185+
bool "Enable record txrx packets for debugging"
186+
depends on IEEE802154_DEBUG
187+
default n
188+
help
189+
Enabling this option to record the tx and rx packets
190+
191+
config IEEE802154_RECORD_TXRX_FRAME_SIZE
192+
int "Record frame table size"
193+
depends on IEEE802154_RECORD_TXRX_FRAME
194+
range 1 50
195+
default 15
196+
help
197+
set the record frame table size
198+
184199
config IEEE802154_TXRX_STATISTIC
185200
bool "Enable record tx/rx packets information for debugging"
186201
depends on IEEE802154_DEBUG
187202
default n
188203
help
189204
Enabling this option to record the tx and rx
205+
190206
endmenu # IEEE 802.15.4

‎components/ieee802154/driver/esp_ieee802154_debug.c‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
@@ -172,6 +172,18 @@ static char *ieee80154_tx_abort_reason_string[] = {
172172
#endif // CONFIG_IEEE802154_RECORD_EVENT
173173

174174
#if CONFIG_IEEE802154_RECORD
175+
#if CONFIG_IEEE802154_RECORD_TXRX_FRAME
176+
static void ieee802154_dump_frame_print(const uint8_t *frame)
177+
{
178+
for (uint8_t i = 1; i < frame[0]; i+=8) {
179+
ESP_EARLY_LOGW(IEEE802154_TAG, "frag(%03d:%03d~%03d): %02x %02x %02x %02x %02x %02x %02x %02x",
180+
frame[0], i, i+7,
181+
frame[i], frame[i+1], frame[i+2], frame[i+3],
182+
frame[i+4], frame[i+5], frame[i+6], frame[i+7]);
183+
}
184+
}
185+
#endif // CONFIG_IEEE802154_RECORD_TXRX_FRAME
186+
175187
void ieee802154_record_print(void)
176188
{
177189
#if CONFIG_IEEE802154_RECORD_EVENT
@@ -234,6 +246,33 @@ void ieee802154_record_print(void)
234246
}
235247
ESP_EARLY_LOGW(IEEE802154_TAG,"Print the record abort done.");
236248
#endif // CONFIG_IEEE802154_RECORD_ABORT
249+
250+
#if CONFIG_IEEE802154_RECORD_TXRX_FRAME
251+
ESP_EARLY_LOGW(IEEE802154_TAG, "Print the dumping tx/rx frame, current frame index: %d", g_ieee802154_probe.frame_index);
252+
for (uint8_t i = 0; i < IEEE802154_RECORD_TXRX_FRAME_SIZE; i++) {
253+
if (g_ieee802154_probe.frame[i].frame_type == IEEE802154_RECORD_FRAME_TYPE_INVALID \
254+
|| g_ieee802154_probe.frame[i].frame_type >= IEEE802154_RECORD_FRAME_TYPE_VALID_MAX) {
255+
continue;
256+
}
257+
if (g_ieee802154_probe.frame[i].frame_type == IEEE802154_RECORD_FRAME_TYPE_RX \
258+
|| g_ieee802154_probe.frame[i].frame_type == IEEE802154_RECORD_FRAME_TYPE_RX_ACK) {
259+
ESP_EARLY_LOGW(IEEE802154_TAG, "index %2d: %s frame, length: %d, buffer index: %d(%s buffer), timestamp: %lld, mac conf: %08x, packet:",
260+
i, (g_ieee802154_probe.frame[i].frame_type == IEEE802154_RECORD_FRAME_TYPE_RX) ? "rx" : "rx ack",
261+
g_ieee802154_probe.frame[i].dump_frame[0], g_ieee802154_probe.frame[i].rx_buffer_index,
262+
(g_ieee802154_probe.frame[i].rx_buffer_index < 0 ? "Invalid" :\
263+
(g_ieee802154_probe.frame[i].rx_buffer_index == CONFIG_IEEE802154_RX_BUFFER_SIZE) ? "Stub" : "Valid"),
264+
g_ieee802154_probe.frame[i].timestamp, g_ieee802154_probe.frame[i].mac_conf);
265+
} else if (g_ieee802154_probe.frame[i].frame_type == IEEE802154_RECORD_FRAME_TYPE_TX \
266+
|| g_ieee802154_probe.frame[i].frame_type == IEEE802154_RECORD_FRAME_TYPE_TX_ACK) {
267+
ESP_EARLY_LOGW(IEEE802154_TAG, "index %2d: %s frame, length: %d, timestamp: %lld, mac conf: %08x, packet:",
268+
i, (g_ieee802154_probe.frame[i].frame_type == IEEE802154_RECORD_FRAME_TYPE_TX) ? "tx" : "tx ack",
269+
g_ieee802154_probe.frame[i].dump_frame[0], g_ieee802154_probe.frame[i].timestamp,
270+
g_ieee802154_probe.frame[i].mac_conf);
271+
}
272+
ieee802154_dump_frame_print(g_ieee802154_probe.frame[i].dump_frame);
273+
}
274+
ESP_EARLY_LOGW(IEEE802154_TAG, "Print the dumped tx/rx frame done.");
275+
#endif // CONFIG_IEEE802154_RECORD_TXRX_FRAME
237276
}
238277
#endif // CONFIG_IEEE802154_RECORD
239278

‎components/ieee802154/private_include/esp_ieee802154_frame.h‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
@@ -14,6 +14,8 @@
1414
extern "C" {
1515
#endif
1616

17+
#define IEEE802154_FRAME_MAX_LEN 127
18+
1719
#define IEEE802154_FRAME_INVALID_OFFSET 0xff
1820
#define IEEE802154_FRAME_INVALID_ADDR_MODE 0xff
1921

@@ -139,9 +141,9 @@ bool ieee802154_frame_is_ack_required(const uint8_t *frame);
139141
* @param[out] addr The pointer to the address.
140142
*
141143
* @return
142-
* - IEEE802154_FRAME_DST_MODE_NONE if destination adress mode is none.
143-
* - IEEE802154_FRAME_DST_MODE_SHORT if destination adress mode is short.
144-
* - IEEE802154_FRAME_DST_MODE_EXT if destination adress mode is extended.
144+
* - IEEE802154_FRAME_DST_MODE_NONE if destination address mode is none.
145+
* - IEEE802154_FRAME_DST_MODE_SHORT if destination address mode is short.
146+
* - IEEE802154_FRAME_DST_MODE_EXT if destination address mode is extended.
145147
*
146148
*/
147149
uint8_t ieee802154_frame_get_dst_addr(const uint8_t *frame, uint8_t *addr);
@@ -153,9 +155,9 @@ uint8_t ieee802154_frame_get_dst_addr(const uint8_t *frame, uint8_t *addr);
153155
* @param[out] addr The pointer to the address.
154156
*
155157
* @return
156-
* - IEEE802154_FRAME_SRC_MODE_NONE if source adress mode is none.
157-
* - IEEE802154_FRAME_SRC_MODE_SHORT if source adress mode is short.
158-
* - IEEE802154_FRAME_SRC_MODE_EXT if source adress mode is extended.
158+
* - IEEE802154_FRAME_SRC_MODE_NONE if source address mode is none.
159+
* - IEEE802154_FRAME_SRC_MODE_SHORT if source address mode is short.
160+
* - IEEE802154_FRAME_SRC_MODE_EXT if source address mode is extended.
159161
*
160162
*/
161163
uint8_t ieee802154_frame_get_src_addr(const uint8_t *frame, uint8_t *addr);

‎components/ieee802154/private_include/esp_ieee802154_util.h‎

Lines changed: 80 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
2+
* SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
@@ -13,6 +13,7 @@
1313
#include "esp_ieee802154_dev.h"
1414
#include "hal/ieee802154_ll.h"
1515
#include "esp_timer.h"
16+
#include "soc/ieee802154_struct.h"
1617
#ifdef __cplusplus
1718
extern "C" {
1819
#endif
@@ -36,8 +37,9 @@ static inline bool ieee802154_is_valid_channel(uint8_t channel)
3637
#endif // SOC_PM_MODEM_RETENTION_BY_REGDMA && CONFIG_FREERTOS_USE_TICKLESS_IDLE
3738
#define IEEE802154_PROBE(a) do { \
3839
IEEE802154_RECORD_EVENT(a); \
39-
ieee802154_record_abort(a); \
40+
IEEE802154_RECORD_ABORT(a); \
4041
IEEE802154_TXRX_STATISTIC(a); \
42+
IEEE802154_RECORD_FRAME(a); \
4143
} while(0)
4244

4345
#if CONFIG_IEEE802154_RECORD_EVENT
@@ -119,7 +121,7 @@ typedef struct {
119121

120122
#if CONFIG_IEEE802154_RECORD_ABORT
121123
#define IEEE802154_ASSERT_RECORD_ABORT_SIZE CONFIG_IEEE802154_RECORD_ABORT_SIZE
122-
#define ieee802154_record_abort(a) do { \
124+
#define IEEE802154_RECORD_ABORT(a) do { \
123125
if (a == IEEE802154_EVENT_RX_ABORT) { \
124126
g_ieee802154_probe.abort[g_ieee802154_probe.abort_index].abort_reason.rx \
125127
= ieee802154_ll_get_rx_abort_reason(); \
@@ -149,29 +151,95 @@ typedef struct {
149151
uint64_t timestamp; /*!< record timestamp*/
150152
} ieee802154_abort_info_t;
151153
#else
152-
#define ieee802154_record_abort(a)
154+
#define IEEE802154_RECORD_ABORT(a)
153155
#endif // CONFIG_IEEE802154_RECORD_ABORT
154156

157+
#if CONFIG_IEEE802154_RECORD_TXRX_FRAME
158+
#define IEEE802154_RECORD_TXRX_FRAME_SIZE CONFIG_IEEE802154_RECORD_TXRX_FRAME_SIZE
159+
#define IEEE802154_RECORD_FRAME_TYPE_INVALID 0
160+
#define IEEE802154_RECORD_FRAME_TYPE_RX 1
161+
#define IEEE802154_RECORD_FRAME_TYPE_TX 2
162+
#define IEEE802154_RECORD_FRAME_TYPE_RX_ACK 3
163+
#define IEEE802154_RECORD_FRAME_TYPE_TX_ACK 4
164+
#define IEEE802154_RECORD_FRAME_TYPE_VALID_MAX 5
165+
166+
#define IEEE802154_DEBUG_RX_FRAME_DUMP(type) do {\
167+
g_ieee802154_probe.frame[g_ieee802154_probe.frame_index].frame_type = type; \
168+
g_ieee802154_probe.frame[g_ieee802154_probe.frame_index].mac_conf = IEEE802154.conf.val; \
169+
if ((((uint8_t *)IEEE802154.dma_rx_addr - &s_rx_frame[0][0]) % IEEE802154_RX_FRAME_SIZE) != 0 \
170+
|| (((uint8_t *)IEEE802154.dma_rx_addr - &s_rx_frame[0][0]) / IEEE802154_RX_FRAME_SIZE) > CONFIG_IEEE802154_RX_BUFFER_SIZE) { \
171+
g_ieee802154_probe.frame[g_ieee802154_probe.frame_index].rx_buffer_index = -1; \
172+
} else { \
173+
g_ieee802154_probe.frame[g_ieee802154_probe.frame_index].rx_buffer_index = \
174+
(((uint8_t *)IEEE802154.dma_rx_addr - &s_rx_frame[0][0]) / IEEE802154_RX_FRAME_SIZE); \
175+
} \
176+
memcpy(g_ieee802154_probe.frame[g_ieee802154_probe.frame_index].dump_frame,\
177+
(void *)IEEE802154.dma_rx_addr, \
178+
IEEE802154_FRAME_MAX_LEN + 1); \
179+
g_ieee802154_probe.frame[g_ieee802154_probe.frame_index++].timestamp = esp_timer_get_time(); \
180+
g_ieee802154_probe.frame_index = (g_ieee802154_probe.frame_index == IEEE802154_RECORD_TXRX_FRAME_SIZE) ? \
181+
0 : g_ieee802154_probe.frame_index; \
182+
} while (0)
183+
184+
#define IEEE802154_DEBUG_TX_FRAME_DUMP(type) do { \
185+
g_ieee802154_probe.frame[g_ieee802154_probe.frame_index].frame_type = type; \
186+
g_ieee802154_probe.frame[g_ieee802154_probe.frame_index].mac_conf = IEEE802154.conf.val; \
187+
memcpy(g_ieee802154_probe.frame[g_ieee802154_probe.frame_index].dump_frame,\
188+
(void *)IEEE802154.dma_tx_addr, \
189+
IEEE802154_FRAME_MAX_LEN + 1); \
190+
g_ieee802154_probe.frame[g_ieee802154_probe.frame_index++].timestamp = esp_timer_get_time(); \
191+
g_ieee802154_probe.frame_index = (g_ieee802154_probe.frame_index == IEEE802154_RECORD_TXRX_FRAME_SIZE) ? \
192+
0 : g_ieee802154_probe.frame_index; \
193+
} while (0)
194+
195+
#define IEEE802154_RECORD_FRAME(a) do { \
196+
if (a == IEEE802154_EVENT_RX_DONE) { \
197+
IEEE802154_DEBUG_RX_FRAME_DUMP(IEEE802154_RECORD_FRAME_TYPE_RX); \
198+
} else if (a == IEEE802154_EVENT_ACK_RX_DONE) { \
199+
IEEE802154_DEBUG_RX_FRAME_DUMP(IEEE802154_RECORD_FRAME_TYPE_RX_ACK); \
200+
} else if (a == IEEE802154_EVENT_TX_DONE) { \
201+
IEEE802154_DEBUG_TX_FRAME_DUMP(IEEE802154_RECORD_FRAME_TYPE_TX); \
202+
} else if (a == IEEE802154_EVENT_ACK_TX_DONE) { \
203+
if (s_ieee802154_state == IEEE802154_STATE_TX_ENH_ACK) { \
204+
IEEE802154_DEBUG_TX_FRAME_DUMP(IEEE802154_RECORD_FRAME_TYPE_TX_ACK); \
205+
} \
206+
} \
207+
} while(0)
208+
typedef struct {
209+
uint8_t frame_type;
210+
uint8_t dump_frame[IEEE802154_FRAME_MAX_LEN + 1];
211+
int8_t rx_buffer_index;
212+
uint32_t mac_conf;
213+
uint64_t timestamp;
214+
} ieee802154_txrx_frame_info_t;
215+
#else
216+
#define IEEE802154_RECORD_FRAME(a)
217+
#endif // CONFIG_IEEE802154_RECORD_TXRX_FRAME
218+
155219
/**
156220
* @brief The table of recording IEEE802154 information.
157221
*/
158222
typedef struct {
159223
#if CONFIG_IEEE802154_RECORD_EVENT
160-
ieee802154_event_info_t event[IEEE802154_ASSERT_RECORD_EVENT_SIZE]; /*!< record radio event */
161-
uint8_t event_index; /*!< the index of event */
224+
ieee802154_event_info_t event[IEEE802154_ASSERT_RECORD_EVENT_SIZE]; /*!< record radio event */
225+
uint8_t event_index; /*!< the index of event */
162226
#endif // CONFIG_IEEE802154_RECORD_EVENT
163227
#if CONFIG_IEEE802154_RECORD_STATE
164-
ieee802154_state_info_t state[IEEE802154_ASSERT_RECORD_STATE_SIZE]; /*!< record radio state */
165-
uint8_t state_index; /*!< the index of state */
228+
ieee802154_state_info_t state[IEEE802154_ASSERT_RECORD_STATE_SIZE]; /*!< record radio state */
229+
uint8_t state_index; /*!< the index of state */
166230
#endif // CONFIG_IEEE802154_RECORD_STATE
167231
#if CONFIG_IEEE802154_RECORD_CMD
168-
ieee802154_cmd_info_t cmd[IEEE802154_ASSERT_RECORD_CMD_SIZE]; /*!< record radio command */
169-
uint8_t cmd_index; /*!< the index of command */
232+
ieee802154_cmd_info_t cmd[IEEE802154_ASSERT_RECORD_CMD_SIZE]; /*!< record radio command */
233+
uint8_t cmd_index; /*!< the index of command */
170234
#endif // CONFIG_IEEE802154_RECORD_CMD
171235
#if CONFIG_IEEE802154_RECORD_ABORT
172-
ieee802154_abort_info_t abort[IEEE802154_ASSERT_RECORD_ABORT_SIZE]; /*!< record radio abort */
173-
uint8_t abort_index; /*!< the index of abort */
236+
ieee802154_abort_info_t abort[IEEE802154_ASSERT_RECORD_ABORT_SIZE]; /*!< record radio abort */
237+
uint8_t abort_index; /*!< the index of abort */
174238
#endif // CONFIG_IEEE802154_RECORD_ABORT
239+
#if CONFIG_IEEE802154_RECORD_TXRX_FRAME
240+
ieee802154_txrx_frame_info_t frame[IEEE802154_RECORD_TXRX_FRAME_SIZE]; /*!< record txrx frame */
241+
uint8_t frame_index; /*!< the index of frame */
242+
#endif // CONFIG_IEEE802154_RECORD_TXRX_FRAME
175243
} ieee802154_probe_info_t;
176244

177245
extern ieee802154_probe_info_t g_ieee802154_probe;

‎examples/ieee802154/ieee802154_cli/sdkconfig.ci.endbg‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
CONFIG_COMPILER_OPTIMIZATION_SIZE=y
2+
CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_SIZE=y
3+
CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_SILENT=y
4+
5+
CONFIG_IEEE802154_DEBUG=y
6+
CONFIG_IEEE802154_ASSERT=y
7+
CONFIG_IEEE802154_RECORD=y
8+
CONFIG_IEEE802154_RECORD_EVENT=y
9+
CONFIG_IEEE802154_RECORD_EVENT_SIZE=30
10+
CONFIG_IEEE802154_RECORD_STATE=y
11+
CONFIG_IEEE802154_RECORD_STATE_SIZE=10
12+
CONFIG_IEEE802154_RECORD_CMD=y
13+
CONFIG_IEEE802154_RECORD_CMD_SIZE=10
14+
CONFIG_IEEE802154_RECORD_ABORT=y
15+
CONFIG_IEEE802154_RECORD_ABORT_SIZE=10
16+
CONFIG_IEEE802154_RECORD_TXRX_FRAME=y
17+
CONFIG_IEEE802154_RECORD_TXRX_FRAME_SIZE=15
18+
19+
CONFIG_ESP_INT_WDT=n
20+
21+
CONFIG_FREERTOS_ISR_STACKSIZE=8192

0 commit comments

Comments
 (0)