mirror of
https://github.com/espressif/openthread.git
synced 2026-07-08 05:10:25 +00:00
Yang Song
e06a3ecdda
This commit introduces new Spinel properties to support CLI service in NCP. * Added `SPINEL_PROP_STREAM_CLI` property: This streaming property provides a bidirectional channel for interacting with the NCP's command-line interface (CLI). The host can send CLI commands to the NCP by setting this property. The NCP will then execute the commands. The NCP will send the output of the executed command (if any) back to the host via unsolicited notifications of this same property.
105 lines
3.7 KiB
C++
105 lines
3.7 KiB
C++
/*
|
|
* Copyright (c) 2025, The OpenThread Authors.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the copyright holder nor the
|
|
* names of its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
|
|
#include "test_platform.h"
|
|
#include "test_util.h"
|
|
#include "common/code_utils.hpp"
|
|
#include "lib/spinel/spinel_buffer.hpp"
|
|
#include "lib/spinel/spinel_encoder.hpp"
|
|
#include "ncp/ncp_base.hpp"
|
|
|
|
#if OPENTHREAD_CONFIG_NCP_CLI_STREAM_ENABLE
|
|
|
|
namespace ot {
|
|
|
|
constexpr uint16_t kMaxSpinelBufferSize = 2048;
|
|
|
|
static otError GenerateSpinelCliCommandFrame(const char *aCommand, uint8_t *aBuf, uint16_t &aLen)
|
|
{
|
|
otError error = OT_ERROR_NONE;
|
|
uint8_t buf[kMaxSpinelBufferSize];
|
|
Spinel::Buffer ncpBuffer(buf, kMaxSpinelBufferSize);
|
|
Spinel::Encoder encoder(ncpBuffer);
|
|
|
|
uint8_t header = SPINEL_HEADER_FLAG | 0 /* Iid */ | 1 /* Tid */;
|
|
SuccessOrExit(error = encoder.BeginFrame(header, SPINEL_CMD_PROP_VALUE_SET, SPINEL_PROP_STREAM_CLI));
|
|
SuccessOrExit(error = encoder.WriteUtf8(aCommand));
|
|
SuccessOrExit(error = encoder.EndFrame());
|
|
|
|
SuccessOrExit(ncpBuffer.OutFrameBegin());
|
|
aLen = ncpBuffer.OutFrameGetLength();
|
|
VerifyOrExit(ncpBuffer.OutFrameRead(aLen, aBuf) == aLen, error = OT_ERROR_FAILED);
|
|
|
|
exit:
|
|
return error;
|
|
}
|
|
|
|
void TestNcpCliCommand(void)
|
|
{
|
|
Instance *instance = static_cast<Instance *>(testInitInstance());
|
|
Ncp::NcpBase ncpBase(instance);
|
|
|
|
uint8_t recvBuf[kMaxSpinelBufferSize];
|
|
uint16_t recvLen;
|
|
|
|
{
|
|
// Test IPv6 interface bring up
|
|
constexpr char cliCommand[] = "ifconfig up";
|
|
|
|
SuccessOrQuit(GenerateSpinelCliCommandFrame(cliCommand, recvBuf, recvLen));
|
|
ncpBase.HandleReceive(recvBuf, recvLen);
|
|
VerifyOrQuit(otIp6IsEnabled(instance) == true);
|
|
}
|
|
|
|
{
|
|
// Test Thread network name set
|
|
constexpr char cliCommand[] = "networkname Test";
|
|
|
|
SuccessOrQuit(GenerateSpinelCliCommandFrame(cliCommand, recvBuf, recvLen));
|
|
ncpBase.HandleReceive(recvBuf, recvLen);
|
|
VerifyOrQuit(strcmp(otThreadGetNetworkName(instance), "Test") == 0);
|
|
}
|
|
|
|
printf("Test Ncp Cli Command passed.\n");
|
|
}
|
|
|
|
} // namespace ot
|
|
|
|
#endif // OPENTHREAD_CONFIG_NCP_CLI_STREAM_ENABLE
|
|
|
|
int main(void)
|
|
{
|
|
#if OPENTHREAD_CONFIG_NCP_CLI_STREAM_ENABLE
|
|
ot::TestNcpCliCommand();
|
|
#endif
|
|
printf("All tests passed\n");
|
|
return 0;
|
|
}
|