Skip to content

Commit

Permalink
[spinel] add support for multiple spinel interfaces (openthread#9360)
Browse files Browse the repository at this point in the history
This feature allows the RCP to support multiple host stacks on different PANs
by making use of the spinel Interface ID.

Created unit tests for testing multipan feature with multiple ot-instance
support.

Based on Si-Labs PR openthread#8914 by @parag-silabs, but a little different approach.
Instead of handling everything by a single sub-mac instance, multiple
OpenThread instances are created on RCP side that map to different IID.
Thanks to this there are separate data kept for each interface. Platform
is able to determine interface by ot instance pointer passed as an argument
to most of the API functions.
Tx/scan queue was removed as it is possible to request transmission in
parallel, it is up to the platform to decide if it should fail or queue
second tx or it has two radios available.

NOTE:
Platform needs to provide different otRadioFrame of each instance and
the processing needs to take into account the instance being used.

Signed-off-by: Marek Porwisz <[email protected]>
  • Loading branch information
MarekPorwisz authored Nov 29, 2023
1 parent f859987 commit 834c8cb
Show file tree
Hide file tree
Showing 40 changed files with 2,324 additions and 171 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/unit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ jobs:
run: ./script/cmake-build simulation
- name: Test Simulation
run: cd build/simulation && ninja test
- name: Build Multipan Simulation
run: ./script/cmake-build simulation -DOT_MULTIPAN_TEST=ON
- name: Test Multipan Simulation
run: cd build/simulation && ninja test
- name: Build POSIX
run: ./script/cmake-build posix
- name: Test POSIX
Expand Down
1 change: 1 addition & 0 deletions doc/ot_api_doc.h
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@
* @defgroup plat-memory Memory
* @defgroup plat-messagepool Message Pool
* @defgroup plat-misc Miscellaneous
* @defgroup plat-multipan Multipan
* @defgroup plat-otns Network Simulator
* @defgroup plat-radio Radio
* @defgroup plat-settings Settings
Expand Down
2 changes: 1 addition & 1 deletion etc/cmake/options.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ ot_option(OT_UDP_FORWARD OPENTHREAD_CONFIG_UDP_FORWARD_ENABLE "UDP forward")
ot_option(OT_UPTIME OPENTHREAD_CONFIG_UPTIME_ENABLE "uptime")

option(OT_DOC "build OpenThread documentation")

option(OT_MULTIPAN_RCP "Multi-PAN RCP" OFF)
message(STATUS "- - - - - - - - - - - - - - - - ")

# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Expand Down
32 changes: 29 additions & 3 deletions examples/apps/ncp/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,24 @@
#include "openthread-system.h"

#include "lib/platform/reset_util.h"

#if OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
#if OPENTHREAD_CONFIG_MULTIPLE_STATIC_INSTANCE_ENABLE == 0
#error "Support for multiple OpenThread static instance is disabled."
#endif
#define ENDPOINT_CT OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_NUM
#else
#define ENDPOINT_CT 1
#endif /* OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE */

/**
* Initializes the NCP app.
*
* @param[in] aInstance The OpenThread instance structure.
*
*/
extern void otAppNcpInit(otInstance *aInstance);
extern void otAppNcpInitMulti(otInstance **aInstances, uint8_t count);

#if OPENTHREAD_CONFIG_HEAP_EXTERNAL_ENABLE
OT_TOOL_WEAK void *otPlatCAlloc(size_t aNum, size_t aSize) { return calloc(aNum, aSize); }
Expand All @@ -70,7 +81,9 @@ int main(int argc, char *argv[])
prctl(PR_SET_PDEATHSIG, SIGHUP);
#endif

#if OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_ENABLE
#if OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
otInstance *instances[ENDPOINT_CT] = {NULL};
#elif OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_ENABLE
size_t otInstanceBufferLength = 0;
uint8_t *otInstanceBuffer = NULL;
#endif
Expand All @@ -79,7 +92,16 @@ int main(int argc, char *argv[])

otSysInit(argc, argv);

#if OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_ENABLE
#if OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
for (int i = 0; i < ENDPOINT_CT; i++)
{
instances[i] = otInstanceInitMultiple(i);

assert(instances[i]);
}
instance = instances[0];
#elif OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_ENABLE

// Call to query the buffer size
(void)otInstanceInit(NULL, &otInstanceBufferLength);

Expand All @@ -94,7 +116,11 @@ int main(int argc, char *argv[])
#endif
assert(instance);

#if OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
otAppNcpInitMulti(instances, ENDPOINT_CT);
#else
otAppNcpInit(instance);
#endif

while (!otSysPseudoResetWasRequested())
{
Expand All @@ -103,7 +129,7 @@ int main(int argc, char *argv[])
}

otInstanceFinalize(instance);
#if OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_ENABLE
#if OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_ENABLE && !OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
free(otInstanceBuffer);
#endif

Expand Down
13 changes: 13 additions & 0 deletions examples/apps/ncp/ncp.c
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,17 @@ void otAppNcpInit(otInstance *aInstance)
otNcpHdlcInit(aInstance, NcpSend);
#endif
}

#if OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
void otAppNcpInitMulti(otInstance **aInstances, uint8_t aCount)
{
#if OPENTHREAD_CONFIG_NCP_SPI_ENABLE
#error Multipan support not implemented for SPI
#else
IgnoreError(otPlatUartEnable());

otNcpHdlcInitMulti(aInstances, aCount, NcpSend);
#endif
}
#endif
#endif // !OPENTHREAD_ENABLE_NCP_VENDOR_HOOK
1 change: 1 addition & 0 deletions examples/platforms/simulation/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ add_library(openthread-simulation
infra_if.c
logging.c
misc.c
multipan.c
radio.c
spi-stubs.c
system.c
Expand Down
66 changes: 66 additions & 0 deletions examples/platforms/simulation/multipan.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
* Copyright (c) 2023, 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 "platform-simulation.h"

#include <errno.h>
#include <sys/time.h>

#include <openthread/platform/multipan.h>

#if OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
static otInstance *sActiveInstance;
#endif

otError otPlatMultipanGetActiveInstance(otInstance **aInstance)
{
otError error = OT_ERROR_NOT_IMPLEMENTED;
OT_UNUSED_VARIABLE(aInstance);

#if OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
*aInstance = sActiveInstance;
error = OT_ERROR_NONE;
#endif

return error;
}

otError otPlatMultipanSetActiveInstance(otInstance *aInstance, bool aCompletePending)
{
otError error = OT_ERROR_NOT_IMPLEMENTED;

OT_UNUSED_VARIABLE(aInstance);
OT_UNUSED_VARIABLE(aCompletePending);

#if OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
sActiveInstance = aInstance;
error = OT_ERROR_NONE;
#endif

return error;
}
1 change: 1 addition & 0 deletions include/openthread/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ source_set("openthread") {
"platform/memory.h",
"platform/messagepool.h",
"platform/misc.h",
"platform/multipan.h",
"platform/otns.h",
"platform/radio.h",
"platform/settings.h",
Expand Down
19 changes: 18 additions & 1 deletion include/openthread/instance.h
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (376)
#define OPENTHREAD_API_VERSION (377)

/**
* @addtogroup api-instance
Expand Down Expand Up @@ -102,6 +102,23 @@ otInstance *otInstanceInit(void *aInstanceBuffer, size_t *aInstanceBufferSize);
*/
otInstance *otInstanceInitSingle(void);

/**
* Initializes the OpenThread instance.
*
* This function initializes OpenThread and prepares it for subsequent OpenThread API calls. This function must be
* called before any other calls to OpenThread. This method utilizes static buffer to initialize the OpenThread
* instance.
*
* This function is available and can only be used when support for multiple OpenThread static instances is
* enabled (`OPENTHREAD_CONFIG_MULTIPLE_STATIC_INSTANCE_ENABLE`)
*
* @param[in] aIdx The index of the OpenThread instance to initialize.
*
* @returns A pointer to the new OpenThread instance.
*
*/
otInstance *otInstanceInitMultiple(uint8_t aIdx);

/**
* Gets the instance identifier.
*
Expand Down
10 changes: 10 additions & 0 deletions include/openthread/ncp.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,16 @@ void otNcpHdlcReceive(const uint8_t *aBuf, uint16_t aBufLength);
*/
void otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback);

/**
* Initialize the NCP based on HDLC framing.
*
* @param[in] aInstances The OpenThread instance pointers array.
* @param[in] aCount Number of elements in the array.
* @param[in] aSendCallback The function pointer used to send NCP data.
*
*/
void otNcpHdlcInitMulti(otInstance **aInstance, uint8_t aCount, otNcpHdlcSendCallback aSendCallback);

/**
* Initialize the NCP based on SPI framing.
*
Expand Down
145 changes: 145 additions & 0 deletions include/openthread/platform/multipan.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/*
* Copyright (c) 2023, 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.
*/

/**
* @file
* @brief
* This file defines the multipan interface for OpenThread.
*
* Multipan RCP is a feature that allows single RCP operate in multiple networks.
*
* Currently we support two types of multipan RCP:
* - Full multipan: RCP operates in parallel on both networks (for example using more than one transceiver)
* - Switching RCP: RCP can communicate only with one network at a time and requires network switching mechanism.
* Switching can be automatic (for example time based, radio sleep based) or manually contolled by
* the host.
*
* Full multipan RCP and Automatic Switching RCP do not require any special care from the host side.
* Manual Switching RCP requires host to switch currently active network.
*
*/

#ifndef OPENTHREAD_PLATFORM_MULTIPAN_H_
#define OPENTHREAD_PLATFORM_MULTIPAN_H_

#include <stdint.h>

#include <openthread/error.h>
#include <openthread/instance.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
* @addtogroup plat-multipan
*
* @brief
* This module includes the platform abstraction for multipan support.
*
* @{
*
*/

/**
* Get instance currently in control of the radio.
*
* If radio does not operate in parallel on all interfaces, this function returns an instance object with granted
* radio access.
*
* @param[out] aInstance Pointer to the variable for storing the active instance pointer.
*
* @retval OT_ERROR_NONE Successfully retrieved the property.
* @retval OT_ERROR_NOT_IMPLEMENTED Failed due to lack of the support in radio.
* @retval OT_ERROR_INVALID_COMMAND Platform supports all interfaces simultaneously.
*
*/
otError otPlatMultipanGetActiveInstance(otInstance **aInstance);

/**
* Set `aInstance` as the current active instance controlling radio.
*
* This function allows selecting the currently active instance on platforms that do not support parallel
* communication on multiple interfaces. In other words, if more than one instance is in a receive state, calling
* #otPlatMultipanSetActiveInstance guarantees that specified instance will be the one receiving. This function returns
* if the request was received properly. After interface switching is complete, the platform should call
* #otPlatMultipanSwitchoverDone. Switching interfaces may take longer if `aCompletePending` is set true.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aCompletePending True if ongoing radio operation should complete before interface switch (Soft switch),
* false for force switch.
*
* @retval OT_ERROR_NONE Successfully set the property.
* @retval OT_ERROR_BUSY Failed due to another operation ongoing.
* @retval OT_ERROR_NOT_IMPLEMENTED Failed due to unknown instance or more instances than interfaces available.
* @retval OT_ERROR_INVALID_COMMAND Platform supports all interfaces simultaneously.
* @retval OT_ERROR_ALREADY Given interface is already active.
*
*/
otError otPlatMultipanSetActiveInstance(otInstance *aInstance, bool aCompletePending);

/**
* The platform completed the interface switching procedure.
*
* Should be invoked immediately after processing #otPlatMultipanSetActiveInstance if no delay is needed, or if
* some longer radio operations need to complete first, after the switch in interfaces is fully complete.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aSuccess True if successfully switched the interfaces, false if switching failed.
*
*/
extern void otPlatMultipanSwitchoverDone(otInstance *aInstance, bool aSuccess);

/**
* Get the instance pointer corresponding to the given IID.
*
* @param[in] aIid The IID of the interface.
*
* @retval Instance pointer if aIid is has an instance assigned, nullptr otherwise.
*/
otInstance *otPlatMultipanIidToInstance(uint8_t aIid);

/**
* Get the IID corresponding to the given OpenThread instance pointer.
*
* @param[in] aInstance The OpenThread instance structure.
*
* @retval IID of the given instance, broadcast IID otherwise.
*/
uint8_t otPlatMultipanInstanceToIid(otInstance *aInstance);

/**
* @}
*
*/

#ifdef __cplusplus
} // end of extern "C"
#endif

#endif // OPENTHREAD_PLATFORM_MULTIPAN_H_
Loading

0 comments on commit 834c8cb

Please sign in to comment.