espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-03 09:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

[spi-hdlc-adapter] define explicit worst-case HDLC frame size macro (#13237)

Browse Source 
This commit replaces the implicit sizing of `escaped_frame_buffer`
with an explicit macro `HDLC_MAX_FRAME_SIZE` in the standalone
`spi-hdlc-adapter` tool.

Previously, `escaped_frame_buffer` was sized statically to
`MAX_FRAME_SIZE * 2` (4096 bytes). While this size is mathematically
sufficient to hold a worst-case escaped payload (4091 bytes for a
2043-byte max payload, 4 escaped CRC bytes, and 1 flag byte), it was
not self-documenting and relied on implicit math.

This commit defines `HDLC_MAX_FRAME_SIZE` explicitly as:
`((MAX_FRAME_SIZE - HEADER_LEN) * 2 + 5)`
making the worst-case framing overhead bounds clear and robust to
any future changes to the constants.
This commit is contained in:
Jonathan Hui
2026-06-11 18:00:57 -07:00
committed by GitHub
parent 11acd4a26e
commit fcf7b4cef5
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/spi-hdlc-adapter/spi-hdlc-adapter.c
+2 -1
View File
@@ -92,6 +92,7 @@
#define MAX_FRAME_SIZE 2048
#define HEADER_LEN 5
#define HDLC_MAX_FRAME_SIZE ((MAX_FRAME_SIZE - HEADER_LEN) * 2 + 5)
#define SPI_HEADER_RESET_FLAG 0x80
#define SPI_HEADER_CRC_FLAG 0x40
#define SPI_HEADER_PATTERN_VALUE 0x02
@@ -803,7 +804,7 @@ static int push_hdlc(void)
{
int ret = 0;
const uint8_t *spiRxFrameBuffer = get_real_rx_frame_start();
static uint8_t escaped_frame_buffer[MAX_FRAME_SIZE * 2];
static uint8_t escaped_frame_buffer[HDLC_MAX_FRAME_SIZE];
static uint16_t unescaped_frame_len;
static uint16_t escaped_frame_len;
static uint16_t escaped_frame_sent;