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

NcpFrameBuffer: Update documentation/comments about in/out frame buffer pointers (#1847)

Browse Source
This commit is contained in:
Abtin Keshavarzian
2017-05-31 09:07:45 -07:00
committed by Jonathan Hui
parent 5943b5d559
commit 1225362a53
1 changed files with 25 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ncp/ncp_buffer.hpp
+25 -7
View File
@@ -320,6 +320,26 @@ private:
* \ / \ /
* Segment #1 Header Segment #2 Header
*
*
* Buffer pointers:
*
* mReadFrameStart
* |
* | mReadSegmentHead mWriteFrameStart
* | | |
* | | mReadPointer | mWriteSegmentHead
* | | | | |
* mBuffer | | | mReadSegmentTail | | mWriteSegmentTail mBufferEnd
* | | | | | | | | |
* V V V V V V V V V
* +-------+---------+---------+-------+--------------------------+---------+---------+----------------------+-
* | ... | Seg 1 | Seg 2 | Seg 3 | . . . | Seg 1 | Seg 2 : . . . |
* +-------+---------+---------+-------+---------------------------+---------+--------+----------------------+-
* \ \ / / \ /
* | Cur segment | | |
* | | | |
* Current OutFrame (being read) Current InFrame (being written)
*
*/
enum
@@ -351,17 +371,15 @@ private:
uint16_t ReadUint16At(uint8_t *aBufPtr);
void WriteUint16At(uint8_t *aBufPtr, uint16_t aValue);
otError InFrameFeedByte(uint8_t aByte);
otError InFrameBeginSegment(void);
otError InFrameFeedByte(uint8_t aByte);
otError InFrameBeginSegment(void);
void InFrameEndSegment(uint16_t aSegmentHeaderFlags);
void InFrameDiscard(void);
otError OutFramePrepareSegment(void);
otError OutFramePrepareSegment(void);
void OutFrameMoveToNextSegment(void);
otError OutFramePrepareMessage(void);
otError OutFrameFillMessageBuffer(void);
// Instance variables
otError OutFramePrepareMessage(void);
otError OutFrameFillMessageBuffer(void);
uint8_t * const mBuffer; // Pointer to the buffer used to store the data.
uint8_t * const mBufferEnd; // Points to after the end of buffer.