1 /*
2 * Copyright (c) 2018, 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"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /**
30 * @file
31 * This file provides an example on how to implement an OpenThread vendor extension.
32 */
33
34 #include "openthread-core-config.h"
35
36 #include <stdbool.h>
37 #include <stdint.h>
38
39 #include "common/code_utils.hpp"
40 #include "common/new.hpp"
41 #include "instance/extension.hpp"
42
43 namespace ot {
44 namespace Extension {
45
46 /**
47 * Defines the vendor extension object.
48 */
49 class Extension : public ExtensionBase
50 {
51 public:
Extension(Instance & aInstance)52 explicit Extension(Instance &aInstance)
53 : ExtensionBase(aInstance)
54 {
55 }
56
57 // TODO: Add vendor extension code (add methods and/or member variables).
58 };
59
60 // ----------------------------------------------------------------------------
61 // `ExtensionBase` API
62 // ----------------------------------------------------------------------------
63
64 static OT_DEFINE_ALIGNED_VAR(sExtensionRaw, sizeof(Extension), uint64_t);
65
Init(Instance & aInstance)66 ExtensionBase &ExtensionBase::Init(Instance &aInstance)
67 {
68 ExtensionBase *ext = reinterpret_cast<ExtensionBase *>(&sExtensionRaw);
69
70 VerifyOrExit(!ext->mIsInitialized);
71
72 ext = new (&sExtensionRaw) Extension(aInstance);
73
74 exit:
75 return *ext;
76 }
77
SignalInstanceInit(void)78 void ExtensionBase::SignalInstanceInit(void)
79 {
80 // OpenThread instance is initialized and ready.
81
82 // TODO: Implement vendor extension code here and start interaction with OpenThread instance.
83 }
84
SignalNcpInit(Ncp::NcpBase & aNcpBase)85 void ExtensionBase::SignalNcpInit(Ncp::NcpBase &aNcpBase)
86 {
87 // NCP instance is initialized and ready.
88
89 // TODO: Implement vendor extension code here and start interaction with NCP instance.
90
91 OT_UNUSED_VARIABLE(aNcpBase);
92 }
93
HandleNotifierEvents(Events aEvents)94 void ExtensionBase::HandleNotifierEvents(Events aEvents)
95 {
96 // TODO: Implement vendor extension code here to handle notifier events.
97
98 OT_UNUSED_VARIABLE(aEvents);
99 }
100
101 } // namespace Extension
102 } // namespace ot
103
