1 /*
2  *    Copyright (c) 2023, The OpenThread Authors.
3  *    All rights reserved.
4  *
5  *    Redistribution and use in source and binary forms, with or without
6  *    modification, are permitted provided that the following conditions are met:
7  *    1. Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *    2. Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *    3. Neither the name of the copyright holder nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  *    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  *    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  *    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
20  *    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  *    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  *    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  *    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  *    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  *    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 /**
29  * @file
30  *   This file implements the multipan radio platform callbacks into OpenThread and default/weak radio platform APIs.
31  */
32 
33 #include <openthread/instance.h>
34 #include <openthread/platform/multipan.h>
35 
36 #include "common/as_core_type.hpp"
37 #include "common/code_utils.hpp"
38 #include "instance/instance.hpp"
39 #include "ncp/ncp_base.hpp"
40 
41 using namespace ot;
42 
43 //---------------------------------------------------------------------------------------------------------------------
44 // otPlatRadio callbacks
45 
otPlatMultipanIidToInstance(uint8_t aIid)46 otInstance *otPlatMultipanIidToInstance(uint8_t aIid)
47 {
48     Ncp::NcpBase *ncpBase = Ncp::NcpBase::GetNcpInstance();
49     OT_ASSERT(ncpBase);
50 
51     return ncpBase->IidToInstance(aIid);
52 }
53 
otPlatMultipanInstanceToIid(otInstance * aInstance)54 uint8_t otPlatMultipanInstanceToIid(otInstance *aInstance)
55 {
56     Ncp::NcpBase *ncpBase = Ncp::NcpBase::GetNcpInstance();
57     OT_ASSERT(ncpBase);
58 
59     return ncpBase->InstanceToIid(static_cast<ot::Instance *>(aInstance));
60 }
61 
62 #if OPENTHREAD_RADIO && OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
63 
otPlatMultipanSwitchoverDone(otInstance * aInstance,bool success)64 void otPlatMultipanSwitchoverDone(otInstance *aInstance, bool success)
65 {
66     Ncp::NcpBase *ncpBase = Ncp::NcpBase::GetNcpInstance();
67     OT_ASSERT(ncpBase);
68 
69     ncpBase->NotifySwitchoverDone(aInstance, success);
70 
71     return;
72 }
73 
74 #else // OPENTHREAD_RADIO && OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
75 
76 // default implementation
otPlatMultipanSwitchoverDone(otInstance * aInstance,bool success)77 OT_TOOL_WEAK void otPlatMultipanSwitchoverDone(otInstance *aInstance, bool success)
78 {
79     OT_UNUSED_VARIABLE(aInstance);
80     OT_UNUSED_VARIABLE(success);
81 }
82 
83 #endif // OPENTHREAD_RADIO && OPENTHREAD_CONFIG_MULTIPAN_RCP_ENABLE
84 
85 //---------------------------------------------------------------------------------------------------------------------
86 // Default/weak implementation of multipan APIs
87 
otPlatMultipanGetActiveInstance(otInstance ** aInstance)88 OT_TOOL_WEAK otError otPlatMultipanGetActiveInstance(otInstance **aInstance)
89 {
90     OT_UNUSED_VARIABLE(aInstance);
91 
92     return kErrorNotImplemented;
93 }
94 
otPlatMultipanSetActiveInstance(otInstance * aInstance,bool aCompletePending)95 OT_TOOL_WEAK otError otPlatMultipanSetActiveInstance(otInstance *aInstance, bool aCompletePending)
96 {
97     OT_UNUSED_VARIABLE(aInstance);
98     OT_UNUSED_VARIABLE(aCompletePending);
99 
100     return kErrorNotImplemented;
101 }
102