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

[rcp] RCP to inform host of its supported RCP API version range (#8617)

Browse Source 
This commit adds a new mechanism for RCP to inform host of the range
of RCP API versions that it can work with. This helps address
situations where RCP may be running a newer firmware (with higher
RCP API version) and host side is older, ensuring that version
checks can be performed correctly.

This commit introduces a new RCP-specific spinel property
`SPINEL_PROP_RCP_MIN_HOST_API_VERSION`. This new property is
available when RCP indicates that it has the newly added capability
`SPINEL_CAP_RCP_MIN_HOST_API_VERSION`. This is used on host side to
determine if we can get this property from RCP.

With addition of this new property, the `RadioSpinel` version check
code is changed to get the min version from RCP itself and then check
on the host side that its version is within the supported range.
This commit is contained in:
Abtin Keshavarzian
2023-01-09 09:47:38 -08:00
committed by GitHub
parent fd9f3237eb
commit bf5576c93b
7 changed files with 103 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/lib/spinel/radio_spinel.hpp
+6 -4
View File
@@ -727,14 +727,16 @@ public:
/**
* This method checks whether the spinel interface is radio-only.
*
* @param[out] aSupportsRcpApiVersion A reference to a boolean variable to update whether the list of spinel
* capabilities include `SPINEL_CAP_RCP_API_VERSION`.
* @param[out] aSupportsRcpApiVersion A reference to a boolean variable to update whether the list of
* spinel capabilities includes `SPINEL_CAP_RCP_API_VERSION`.
* @param[out] aSupportsRcpMinHostApiVersion A reference to a boolean variable to update whether the list of
* spinel capabilities includes `SPINEL_CAP_RCP_MIN_HOST_API_VERSION`.
*
* @retval TRUE The radio chip is in radio-only mode.
* @retval FALSE Otherwise.
*
*/
bool IsRcp(bool &aSupportsRcpApiVersion);
bool IsRcp(bool &aSupportsRcpApiVersion, bool &aSupportsRcpMinHostApiVersion);
/**
* This method checks whether there is pending frame in the buffer.
@@ -960,7 +962,7 @@ private:
otError CheckSpinelVersion(void);
otError CheckRadioCapabilities(void);
otError CheckRcpApiVersion(bool aSupportsRcpApiVersion);
otError CheckRcpApiVersion(bool aSupportsRcpApiVersion, bool aSupportsMinHostRcpApiVersion);
/**
* This method triggers a state transfer of the state machine.
src/lib/spinel/radio_spinel_impl.hpp
+67 -20
View File
@@ -231,6 +231,7 @@ void RadioSpinel<InterfaceType, ProcessContextType>::Init(bool aResetRadio,
{
otError error = OT_ERROR_NONE;
bool supportsRcpApiVersion;
bool supportsRcpMinHostApiVersion;
#if OPENTHREAD_SPINEL_CONFIG_RCP_RESTORATION_MAX_COUNT > 0
mResetRadioOnStartup = aResetRadio;
@@ -257,7 +258,7 @@ void RadioSpinel<InterfaceType, ProcessContextType>::Init(bool aResetRadio,
SuccessOrExit(error = Get(SPINEL_PROP_NCP_VERSION, SPINEL_DATATYPE_UTF8_S, mVersion, sizeof(mVersion)));
SuccessOrExit(error = Get(SPINEL_PROP_HWADDR, SPINEL_DATATYPE_EUI64_S, mIeeeEui64.m8));
if (!IsRcp(supportsRcpApiVersion))
if (!IsRcp(supportsRcpApiVersion, supportsRcpMinHostApiVersion))
{
uint8_t exitCode = OT_EXIT_RADIO_SPINEL_INCOMPATIBLE;
@@ -273,7 +274,7 @@ void RadioSpinel<InterfaceType, ProcessContextType>::Init(bool aResetRadio,
if (!aSkipRcpCompatibilityCheck)
{
SuccessOrDie(CheckRcpApiVersion(supportsRcpApiVersion));
SuccessOrDie(CheckRcpApiVersion(supportsRcpApiVersion, supportsRcpMinHostApiVersion));
SuccessOrDie(CheckRadioCapabilities());
}
@@ -309,7 +310,8 @@ exit:
}
template <typename InterfaceType, typename ProcessContextType>
bool RadioSpinel<InterfaceType, ProcessContextType>::IsRcp(bool &aSupportsRcpApiVersion)
bool RadioSpinel<InterfaceType, ProcessContextType>::IsRcp(bool &aSupportsRcpApiVersion,
bool &aSupportsRcpMinHostApiVersion)
{
uint8_t capsBuffer[kCapsBufferSize];
const uint8_t *capsData = capsBuffer;
@@ -317,7 +319,8 @@ bool RadioSpinel<InterfaceType, ProcessContextType>::IsRcp(bool &aSupportsRcpApi
bool supportsRawRadio = false;
bool isRcp = false;
aSupportsRcpApiVersion = false;
aSupportsRcpApiVersion = false;
aSupportsRcpMinHostApiVersion = false;
SuccessOrDie(Get(SPINEL_PROP_CAPS, SPINEL_DATATYPE_DATA_S, capsBuffer, &capsLength));
@@ -349,6 +352,11 @@ bool RadioSpinel<InterfaceType, ProcessContextType>::IsRcp(bool &aSupportsRcpApi
aSupportsRcpApiVersion = true;
}
if (capability == SPINEL_PROP_RCP_MIN_HOST_API_VERSION)
{
aSupportsRcpMinHostApiVersion = true;
}
capsData += unpacked;
capsLength -= static_cast<spinel_size_t>(unpacked);
}
@@ -400,27 +408,50 @@ exit:
}
template <typename InterfaceType, typename ProcessContextType>
otError RadioSpinel<InterfaceType, ProcessContextType>::CheckRcpApiVersion(bool aSupportsRcpApiVersion)
otError RadioSpinel<InterfaceType, ProcessContextType>::CheckRcpApiVersion(bool aSupportsRcpApiVersion,
bool aSupportsRcpMinHostApiVersion)
{
otError error = OT_ERROR_NONE;
unsigned int rcpApiVersion = 1;
// Use RCP API Version value 1, when the RCP capability
// list does not contain `SPINEL_CAP_RCP_API_VERSION`.
if (aSupportsRcpApiVersion)
{
SuccessOrExit(error = Get(SPINEL_PROP_RCP_API_VERSION, SPINEL_DATATYPE_UINT_PACKED_S, &rcpApiVersion));
}
otError error = OT_ERROR_NONE;
static_assert(SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION <= SPINEL_RCP_API_VERSION,
"MIN_HOST_SUPPORTED_RCP_API_VERSION must be smaller than or equal to RCP_API_VERSION");
if ((rcpApiVersion < SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION) || (rcpApiVersion > SPINEL_RCP_API_VERSION))
if (aSupportsRcpApiVersion)
{
otLogCritPlat("RCP API Version %u is not in the supported range [%u-%u]", rcpApiVersion,
SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION, SPINEL_RCP_API_VERSION);
DieNow(OT_EXIT_RADIO_SPINEL_INCOMPATIBLE);
// Make sure RCP is not too old and its version is within the
// range host supports.
unsigned int rcpApiVersion;
SuccessOrExit(error = Get(SPINEL_PROP_RCP_API_VERSION, SPINEL_DATATYPE_UINT_PACKED_S, &rcpApiVersion));
if (rcpApiVersion < SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION)
{
otLogCritPlat("RCP and host are using incompatible API versions");
otLogCritPlat("RCP API Version %u is older than min required by host %u", rcpApiVersion,
SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION);
DieNow(OT_EXIT_RADIO_SPINEL_INCOMPATIBLE);
}
}
if (aSupportsRcpMinHostApiVersion)
{
// Check with RCP about min host API version it can work with,
// and make sure on host side our version is within the supported
// range.
unsigned int minHostRcpApiVersion;
SuccessOrExit(
error = Get(SPINEL_PROP_RCP_MIN_HOST_API_VERSION, SPINEL_DATATYPE_UINT_PACKED_S, &minHostRcpApiVersion));
if (SPINEL_RCP_API_VERSION < minHostRcpApiVersion)
{
otLogCritPlat("RCP and host are using incompatible API versions");
otLogCritPlat("RCP requires min host API version %u but host is older and at version %u",
minHostRcpApiVersion, SPINEL_RCP_API_VERSION);
DieNow(OT_EXIT_RADIO_SPINEL_INCOMPATIBLE);
}
}
exit:
@@ -2763,6 +2794,7 @@ void RadioSpinel<InterfaceType, ProcessContextType>::LogSpinelFrame(const uint8_
case SPINEL_PROP_RADIO_CAPS:
case SPINEL_PROP_RCP_API_VERSION:
case SPINEL_PROP_RCP_MIN_HOST_API_VERSION:
{
const char *name;
unsigned int value;
@@ -2770,7 +2802,22 @@ void RadioSpinel<InterfaceType, ProcessContextType>::LogSpinelFrame(const uint8_
unpacked = spinel_datatype_unpack(data, len, SPINEL_DATATYPE_UINT_PACKED_S, &value);
VerifyOrExit(unpacked > 0, error = OT_ERROR_PARSE);
name = (key == SPINEL_PROP_RADIO_CAPS) ? "caps" : "version";
switch (key)
{
case SPINEL_PROP_RADIO_CAPS:
name = "caps";
break;
case SPINEL_PROP_RCP_API_VERSION:
name = "version";
break;
case SPINEL_PROP_RCP_MIN_HOST_API_VERSION:
name = "min-host-version";
break;
default:
name = "";
break;
}
start += Snprintf(start, static_cast<uint32_t>(end - start), ", %s:%u", name, value);
}
break;
src/lib/spinel/spinel.c
+1
View File
@@ -1426,6 +1426,7 @@ const char *spinel_prop_key_to_cstr(spinel_prop_key_t prop_key)
{SPINEL_PROP_SERVER_SERVICES, "SERVER_SERVICES"},
{SPINEL_PROP_SERVER_LEADER_SERVICES, "SERVER_LEADER_SERVICES"},
{SPINEL_PROP_RCP_API_VERSION, "RCP_API_VERSION"},
{SPINEL_PROP_RCP_MIN_HOST_API_VERSION, "RCP_MIN_HOST_API_VERSION"},
{SPINEL_PROP_UART_BITRATE, "UART_BITRATE"},
{SPINEL_PROP_UART_XON_XOFF, "UART_XON_XOFF"},
{SPINEL_PROP_15_4_PIB_PHY_CHANNELS_SUPPORTED, "15_4_PIB_PHY_CHANNELS_SUPPORTED"},
src/lib/spinel/spinel.h
+22 -6
View File
@@ -325,8 +325,11 @@
* as constant as possible.
*
* - On start, host implementation queries the RCP API version and accepts
* any version number from SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION up to
* and including SPINEL_RCP_API_VERSION.
* any version starting from SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION.
*
* - Host implementation also queries the RCP about the minimum host RCP
* API version it can work with, and then checks that its own version is
* within the range.
*
* Host and RCP compatibility guideline:
*
@@ -417,7 +420,7 @@
* Please see section "Spinel definition compatibility guideline" for more details.
*
*/
#define SPINEL_RCP_API_VERSION 7
#define SPINEL_RCP_API_VERSION 8
/**
* @def SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION
@@ -1278,9 +1281,10 @@ enum
SPINEL_CAP_NET_THREAD_1_2 = (SPINEL_CAP_NET__BEGIN + 2),
SPINEL_CAP_NET__END = 64,
SPINEL_CAP_RCP__BEGIN = 64,
SPINEL_CAP_RCP_API_VERSION = (SPINEL_CAP_RCP__BEGIN + 0),
SPINEL_CAP_RCP__END = 80,
SPINEL_CAP_RCP__BEGIN = 64,
SPINEL_CAP_RCP_API_VERSION = (SPINEL_CAP_RCP__BEGIN + 0),
SPINEL_CAP_RCP_MIN_HOST_API_VERSION = (SPINEL_CAP_RCP__BEGIN + 1),
SPINEL_CAP_RCP__END = 80,
SPINEL_CAP_OPENTHREAD__BEGIN = 512,
SPINEL_CAP_MAC_ALLOWLIST = (SPINEL_CAP_OPENTHREAD__BEGIN + 0),
@@ -4349,6 +4353,18 @@ enum
*/
SPINEL_PROP_RCP_API_VERSION = SPINEL_PROP_RCP__BEGIN + 0,
/// Min host RCP API Version number
/** Format: `i` (read-only)
*
* Required capability: SPINEL_CAP_RADIO and SPINEL_CAP_RCP_MIN_HOST_API_VERSION.
*
* This property gives the minimum host RCP API Version number.
*
* Please see "Spinel definition compatibility guideline" section.
*
*/
SPINEL_PROP_RCP_MIN_HOST_API_VERSION = SPINEL_PROP_RCP__BEGIN + 1,
SPINEL_PROP_RCP__END = 0xFF,
SPINEL_PROP_INTERFACE__BEGIN = 0x100,
src/ncp/ncp_base.cpp
+1
View File
@@ -1844,6 +1844,7 @@ template <> otError NcpBase::HandlePropertyGet<SPINEL_PROP_CAPS>(void)
#if OPENTHREAD_RADIO
SuccessOrExit(error = mEncoder.WriteUintPacked(SPINEL_CAP_RCP_API_VERSION));
SuccessOrExit(error = mEncoder.WriteUintPacked(SPINEL_CAP_RCP_MIN_HOST_API_VERSION));
#endif
#if OPENTHREAD_PLATFORM_POSIX
src/ncp/ncp_base_dispatcher.cpp
+1
View File
@@ -153,6 +153,7 @@ NcpBase::PropertyHandler NcpBase::FindGetPropertyHandler(spinel_prop_key_t aKey)
#endif // OPENTHREAD_MTD || OPENTHREAD_FTD
#if OPENTHREAD_RADIO
OT_NCP_GET_HANDLER_ENTRY(SPINEL_PROP_RCP_API_VERSION),
OT_NCP_GET_HANDLER_ENTRY(SPINEL_PROP_RCP_MIN_HOST_API_VERSION),
#endif
#if OPENTHREAD_MTD || OPENTHREAD_FTD
OT_NCP_GET_HANDLER_ENTRY(SPINEL_PROP_CNTR_TX_PKT_TOTAL),
src/ncp/ncp_base_radio.cpp
+5
View File
@@ -53,6 +53,11 @@ template <> otError NcpBase::HandlePropertyGet<SPINEL_PROP_RCP_API_VERSION>(void
{
return mEncoder.WriteUintPacked(SPINEL_RCP_API_VERSION);
}
template <> otError NcpBase::HandlePropertyGet<SPINEL_PROP_RCP_MIN_HOST_API_VERSION>(void)
{
return mEncoder.WriteUintPacked(SPINEL_MIN_HOST_SUPPORTED_RCP_API_VERSION);
}
#endif
// ----------------------------------------------------------------------------