espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-26 20:19:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

[common] refactor FrameBuilder and FrameData to use templated API (#13216)

Browse Source 
This commit refactors the `FrameBuilder` and `FrameData` modules,
replacing multiple distinct endian-specific methods with a unified,
type-safe templated API.

Key changes:
- Introduced `enum Encoding` (`kBigEndian`, `kLittleEndian`) and a
  templated `HostSwap<Encoding, UintType>` helper in `encoding.hpp` to
  centralize byte-swapping logic.
- Replaced `AppendBigEndianUint16()`, `AppendLittleEndianUint32()`,
  and other variations in `FrameBuilder` with a single templated
  method: `AppendUint<Encoding, UintType>()`.
- Replaced `ReadBigEndianUint16()`, `ReadLittleEndianUint32()`,
  and other variations in `FrameData` with a single templated
  method: `ReadUint<Encoding, UintType>()`.
- Updated all callers in `Lowpan` and `Mac` modules to use the new
  templated encoding APIs.
- Updated `test_frame_builder.cpp` to validate the new syntax.
This commit is contained in:
Abtin Keshavarzian
2026-06-08 19:34:19 -07:00
committed by GitHub
parent 87b971ef96
commit 8abf9667c3
8 changed files with 105 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/unit/test_frame_builder.cpp
+10 -4
View File
@@ -49,6 +49,8 @@ void TestFrameBuilder(void)
uint8_t buffer[kMaxBufferSize];
uint8_t zeroBuffer[kMaxBufferSize];
FrameBuilder frameBuilder;
uint16_t u16;
uint32_t u32;
printf("TestFrameBuilder\n");
@@ -93,14 +95,17 @@ void TestFrameBuilder(void)
VerifyOrQuit(!frameBuilder.CanAppend(sizeof(buffer) - sizeof(kData1) + 1));
SuccessOrQuit(frameBuilder.AppendUint8(0x01));
SuccessOrQuit(frameBuilder.AppendBigEndianUint16(0x0203));
SuccessOrQuit(frameBuilder.AppendLittleEndianUint16(0x0504));
u16 = 0x203;
SuccessOrQuit(frameBuilder.AppendUint<kBigEndian>(u16));
u16 = 0x0504;
SuccessOrQuit(frameBuilder.AppendUint<kLittleEndian>(u16));
VerifyOrQuit(frameBuilder.GetLength() == sizeof(kData1) * 2);
VerifyOrQuit(frameBuilder.GetBytes() == buffer);
VerifyOrQuit(memcmp(buffer, kData1, sizeof(kData1)) == 0);
VerifyOrQuit(memcmp(buffer + sizeof(kData1), kData1, sizeof(kData1)) == 0);
SuccessOrQuit(frameBuilder.AppendBigEndianUint32(0x01020304));
u32 = 0x01020304;
SuccessOrQuit(frameBuilder.AppendUint<kBigEndian>(u32));
SuccessOrQuit(frameBuilder.AppendUint8(0x05));
VerifyOrQuit(frameBuilder.GetLength() == sizeof(kData1) * 3);
VerifyOrQuit(frameBuilder.GetBytes() == buffer);
@@ -124,7 +129,8 @@ void TestFrameBuilder(void)
VerifyOrQuit(frameBuilder.GetLength() == 0);
VerifyOrQuit(frameBuilder.GetMaxLength() == sizeof(buffer));
SuccessOrQuit(frameBuilder.AppendLittleEndianUint32(0x04030201));
u32 = 0x04030201;
SuccessOrQuit(frameBuilder.AppendUint<kLittleEndian>(u32));
SuccessOrQuit(frameBuilder.AppendUint8(0x05));
VerifyOrQuit(frameBuilder.GetLength() == sizeof(kData1));
VerifyOrQuit(frameBuilder.GetBytes() == buffer);