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

Ncp: Simplify Tx Buffer Management (#1401)

Browse Source 
This commit changes the `NcpBase` class so that it defines and
controls the NCP Tx buffer used for outbound spinel message (instead
of delegating this to the sub-classes `NcpUart` and `NcpSpi`).

This removes the need to use abstract `virtual` methods in the base
class. It also simplifies the code by removing the common/duplicate
implementation in each sub-class.
This commit is contained in:
Abtin Keshavarzian
2017-02-28 21:58:09 -08:00
committed by Jonathan Hui
parent 1eae7fbef1
commit 590d8f055a
6 changed files with 40 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ncp/ncp_base.cpp
+25
View File
@@ -491,6 +491,7 @@ static uint8_t BorderRouterConfigToFlagByte(const otBorderRouterConfig &config)
NcpBase::NcpBase(otInstance *aInstance):
mInstance(aInstance),
mTxFrameBuffer(mTxBuffer, sizeof(mTxBuffer)),
mLastStatus(SPINEL_STATUS_OK),
mSupportedChannelMask(kPhySupportedChannelMask),
mChannelMask(kPhySupportedChannelMask),
@@ -544,6 +545,30 @@ NcpBase::NcpBase(otInstance *aInstance):
#endif
}
// ----------------------------------------------------------------------------
// MARK: Outbound Frame methods
// ----------------------------------------------------------------------------
ThreadError NcpBase::OutboundFrameBegin(void)
{
return mTxFrameBuffer.InFrameBegin();
}
ThreadError NcpBase::OutboundFrameFeedData(const uint8_t *aDataBuffer, uint16_t aDataBufferLength)
{
return mTxFrameBuffer.InFrameFeedData(aDataBuffer, aDataBufferLength);
}
ThreadError NcpBase::OutboundFrameFeedMessage(otMessage aMessage)
{
return mTxFrameBuffer.InFrameFeedMessage(aMessage);
}
ThreadError NcpBase::OutboundFrameEnd(void)
{
return mTxFrameBuffer.InFrameEnd();
}
// ----------------------------------------------------------------------------
// MARK: Outbound Datagram Handling
// ----------------------------------------------------------------------------
src/ncp/ncp_base.hpp
+14 -4
View File
@@ -44,6 +44,7 @@
#include <openthread-ip6.h>
#include <common/tasklet.hpp>
#include <ncp/ncp.h>
#include <ncp/ncp_buffer.hpp>
#include "spinel.h"
@@ -75,7 +76,7 @@ protected:
* @retval kThreadError_NoBufs Insufficient buffer space available to start a new frame.
*
*/
virtual ThreadError OutboundFrameBegin(void) = 0;
ThreadError OutboundFrameBegin(void);
/**
* This method adds data to the current outbound frame being written.
@@ -89,7 +90,7 @@ protected:
* @retval kThreadError_NoBufs Insufficient buffer space available to add data.
*
*/
virtual ThreadError OutboundFrameFeedData(const uint8_t *aDataBuffer, uint16_t aDataBufferLength) = 0;
ThreadError OutboundFrameFeedData(const uint8_t *aDataBuffer, uint16_t aDataBufferLength);
/**
* This method adds a message to the current outbound frame being written.
@@ -104,7 +105,7 @@ protected:
* @retval kThreadError_NoBufs Insufficient buffer space available to add message.
*
*/
virtual ThreadError OutboundFrameFeedMessage(otMessage aMessage) = 0;
ThreadError OutboundFrameFeedMessage(otMessage aMessage);
/**
* This method finalizes and sends the current outbound frame
@@ -115,7 +116,7 @@ protected:
* @retval kThreadError_NoBufs Insufficient buffer space available to add message.
*
*/
virtual ThreadError OutboundFrameEnd(void) = 0;
ThreadError OutboundFrameEnd(void);
/**
* This method is called by the framer whenever a framing error
@@ -575,7 +576,14 @@ public:
void RegisterLegacyHandlers(const otNcpLegacyHandlers *aHandlers);
#endif
protected:
NcpFrameBuffer mTxFrameBuffer;
private:
enum
{
kTxBufferSize = OPENTHREAD_CONFIG_NCP_TX_BUFFER_SIZE, // Tx Buffer size (used by mTxFrameBuffer).
};
spinel_status_t mLastStatus;
@@ -601,6 +609,8 @@ private:
spinel_tid_t mNextExpectedTid;
uint8_t mTxBuffer[kTxBufferSize];
bool mAllowLocalNetworkDataChange;
bool mRequireJoinExistingNetwork;
bool mIsRawStreamEnabled;
src/ncp/ncp_spi.cpp
+1 -22
View File
@@ -89,8 +89,7 @@ static uint16_t spi_header_get_data_len(const uint8_t *header)
NcpSpi::NcpSpi(otInstance *aInstance):
NcpBase(aInstance),
mHandleRxFrameTask(aInstance->mIp6.mTaskletScheduler, &NcpSpi::HandleRxFrame, this),
mPrepareTxFrameTask(aInstance->mIp6.mTaskletScheduler, &NcpSpi::PrepareTxFrame, this),
mTxFrameBuffer(mTxBuffer, sizeof(mTxBuffer))
mPrepareTxFrameTask(aInstance->mIp6.mTaskletScheduler, &NcpSpi::PrepareTxFrame, this)
{
memset(mEmptySendFrame, 0, kSpiHeaderLength);
memset(mSendFrame, 0, kSpiHeaderLength);
@@ -232,26 +231,6 @@ NcpSpi::SpiTransactionComplete(
);
}
ThreadError NcpSpi::OutboundFrameBegin(void)
{
return mTxFrameBuffer.InFrameBegin();
}
ThreadError NcpSpi::OutboundFrameFeedData(const uint8_t *aDataBuffer, uint16_t aDataBufferLength)
{
return mTxFrameBuffer.InFrameFeedData(aDataBuffer, aDataBufferLength);
}
ThreadError NcpSpi::OutboundFrameFeedMessage(otMessage aMessage)
{
return mTxFrameBuffer.InFrameFeedMessage(aMessage);
}
ThreadError NcpSpi::OutboundFrameEnd(void)
{
return mTxFrameBuffer.InFrameEnd();
}
void NcpSpi::TxFrameBufferHasData(void *aContext, NcpFrameBuffer *aNcpFrameBuffer)
{
(void)aContext;
src/ncp/ncp_spi.hpp
-9
View File
@@ -40,7 +40,6 @@
#endif
#include <ncp/ncp_base.hpp>
#include <ncp/ncp_buffer.hpp>
namespace Thread {
@@ -57,11 +56,6 @@ public:
*/
NcpSpi(otInstance *aInstance);
virtual ThreadError OutboundFrameBegin(void);
virtual ThreadError OutboundFrameFeedData(const uint8_t *frame, uint16_t frameLength);
virtual ThreadError OutboundFrameFeedMessage(otMessage message);
virtual ThreadError OutboundFrameEnd(void);
void ReceiveTask(const uint8_t *aBuf, uint16_t aBufLength);
private:
@@ -69,7 +63,6 @@ private:
{
kSpiBufferSize = OPENTHREAD_CONFIG_NCP_SPI_BUFFER_SIZE, // Spi buffer size (should be large enough to fit a
// max length frame + spi header).
kTxBufferSize = OPENTHREAD_CONFIG_NCP_TX_BUFFER_SIZE, // Tx Buffer size (used by mTxFrameBuffer).
kSpiHeaderLength = 5, // Size of spi header.
};
@@ -122,8 +115,6 @@ private:
uint8_t mEmptySendFrame[kSpiHeaderLength];
uint8_t mEmptyReceiveFrame[kSpiHeaderLength];
uint8_t mTxBuffer[kTxBufferSize];
NcpFrameBuffer mTxFrameBuffer;
};
} // namespace Thread
src/ncp/ncp_uart.cpp
-21
View File
@@ -89,7 +89,6 @@ NcpUart::NcpUart(otInstance *aInstance):
NcpBase(aInstance),
mFrameDecoder(mRxBuffer, sizeof(mRxBuffer), &NcpUart::HandleFrame, &NcpUart::HandleError, this),
mUartBuffer(),
mTxFrameBuffer(mTxBuffer, sizeof(mTxBuffer)),
mState(kStartingFrame),
mByte(0),
mUartSendTask(aInstance->mIp6.mTaskletScheduler, EncodeAndSendToUart, this)
@@ -99,26 +98,6 @@ NcpUart::NcpUart(otInstance *aInstance):
otPlatUartEnable();
}
ThreadError NcpUart::OutboundFrameBegin(void)
{
return mTxFrameBuffer.InFrameBegin();
}
ThreadError NcpUart::OutboundFrameFeedData(const uint8_t *aDataBuffer, uint16_t aDataBufferLength)
{
return mTxFrameBuffer.InFrameFeedData(aDataBuffer, aDataBufferLength);
}
ThreadError NcpUart::OutboundFrameFeedMessage(otMessage aMessage)
{
return mTxFrameBuffer.InFrameFeedMessage(aMessage);
}
ThreadError NcpUart::OutboundFrameEnd(void)
{
return mTxFrameBuffer.InFrameEnd();
}
void NcpUart::TxFrameBufferHasData(void *aContext, NcpFrameBuffer *aNcpFrameBuffer)
{
(void)aContext;
src/ncp/ncp_uart.hpp
-53
View File
@@ -41,7 +41,6 @@
#include <ncp/ncp_base.hpp>
#include <ncp/hdlc.hpp>
#include <ncp/ncp_buffer.hpp>
namespace Thread {
@@ -58,55 +57,6 @@ public:
*/
NcpUart(otInstance *aInstance);
/**
* This method is called to start a new outbound frame.
*
* @retval kThreadError_None Successfully started a new frame.
* @retval kThreadError_NoBufs Insufficient buffer space available to start a new frame.
*
*/
virtual ThreadError OutboundFrameBegin(void);
/**
* This method adds data to the current outbound frame being written.
*
* If no buffer space is available, this method will discard and clear the frame before returning an error status.
*
* @param[in] aDataBuffer A pointer to data buffer.
* @param[in] aDataBufferLength The length of the data buffer.
*
* @retval kThreadError_None Successfully added new data to the frame.
* @retval kThreadError_NoBufs Insufficient buffer space available to add data.
*
*/
virtual ThreadError OutboundFrameFeedData(const uint8_t *aDataBuffer, uint16_t aDataBufferLength);
/**
* This method adds a message to the current outbound frame being written.
*
* If no buffer space is available, this method will discard and clear the frame before returning an error status.
* In case of success, the passed-in message @aMessage will be owned by outbound buffer and will be freed
* when either the the frame is successfully sent and removed or if the frame is discarded.
*
* @param[in] aMessage A message instance to be added to current frame.
*
* @retval kThreadError_None Successfully added the message to the frame.
* @retval kThreadError_NoBufs Insufficient buffer space available to add message.
*
*/
virtual ThreadError OutboundFrameFeedMessage(otMessage aMessage);
/**
* This method finalizes and sends the current outbound frame.
*
* If no buffer space is available, this method will discard and clear the frame before returning an error status.
*
* @retval kThreadError_None Successfully added the message to the frame.
* @retval kThreadError_NoBufs Insufficient buffer space available to add message.
*
*/
virtual ThreadError OutboundFrameEnd(void);
/**
* This method is called when uart tx is finished. It prepares and sends the next data chunk (if any) to uart.
*
@@ -124,7 +74,6 @@ private:
enum
{
kUartTxBufferSize = OPENTHREAD_CONFIG_NCP_UART_TX_CHUNK_SIZE, // Uart tx buffer size.
kTxBufferSize = OPENTHREAD_CONFIG_NCP_TX_BUFFER_SIZE, // Tx Buffer size (used by mTxFrameBuffer).
kRxBufferSize = OPENTHREAD_CONFIG_NCP_UART_RX_BUFFER_SIZE, // Rx buffer size (should be large enough to fit
// one whole (decoded) received frame).
};
@@ -163,10 +112,8 @@ private:
Hdlc::Encoder mFrameEncoder;
Hdlc::Decoder mFrameDecoder;
UartTxBuffer mUartBuffer;
NcpFrameBuffer mTxFrameBuffer;
UartTxState mState;
uint8_t mByte;
uint8_t mTxBuffer[kTxBufferSize];
uint8_t mRxBuffer[kRxBufferSize];
Tasklet mUartSendTask;
};