1 /*
2 * Copyright (c) 2016, 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 implements the PAN ID Query Client.
32 */
33
34 #include "panid_query_client.hpp"
35
36 #if OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
37
38 #include "instance/instance.hpp"
39
40 namespace ot {
41
42 RegisterLogModule("PanIdQueryClnt");
43
PanIdQueryClient(Instance & aInstance)44 PanIdQueryClient::PanIdQueryClient(Instance &aInstance)
45 : InstanceLocator(aInstance)
46 {
47 }
48
SendQuery(uint16_t aPanId,uint32_t aChannelMask,const Ip6::Address & aAddress,otCommissionerPanIdConflictCallback aCallback,void * aContext)49 Error PanIdQueryClient::SendQuery(uint16_t aPanId,
50 uint32_t aChannelMask,
51 const Ip6::Address &aAddress,
52 otCommissionerPanIdConflictCallback aCallback,
53 void *aContext)
54 {
55 Error error = kErrorNone;
56 Tmf::MessageInfo messageInfo(GetInstance());
57 Coap::Message *message = nullptr;
58
59 VerifyOrExit(Get<MeshCoP::Commissioner>().IsActive(), error = kErrorInvalidState);
60 VerifyOrExit((message = Get<Tmf::Agent>().NewPriorityMessage()) != nullptr, error = kErrorNoBufs);
61
62 SuccessOrExit(error = message->InitAsPost(aAddress, kUriPanIdQuery));
63 SuccessOrExit(error = message->SetPayloadMarker());
64
65 SuccessOrExit(
66 error = Tlv::Append<MeshCoP::CommissionerSessionIdTlv>(*message, Get<MeshCoP::Commissioner>().GetSessionId()));
67
68 SuccessOrExit(error = MeshCoP::ChannelMaskTlv::AppendTo(*message, aChannelMask));
69
70 SuccessOrExit(error = Tlv::Append<MeshCoP::PanIdTlv>(*message, aPanId));
71
72 messageInfo.SetSockAddrToRlocPeerAddrTo(aAddress);
73 SuccessOrExit(error = Get<Tmf::Agent>().SendMessage(*message, messageInfo));
74
75 LogInfo("Sent %s", UriToString<kUriPanIdQuery>());
76
77 mCallback.Set(aCallback, aContext);
78
79 exit:
80 FreeMessageOnError(message, error);
81 return error;
82 }
83
84 template <>
HandleTmf(Coap::Message & aMessage,const Ip6::MessageInfo & aMessageInfo)85 void PanIdQueryClient::HandleTmf<kUriPanIdConflict>(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo)
86 {
87 uint16_t panId;
88 uint32_t mask;
89
90 VerifyOrExit(aMessage.IsConfirmablePostRequest());
91
92 LogInfo("Received %s", UriToString<kUriPanIdConflict>());
93
94 SuccessOrExit(Tlv::Find<MeshCoP::PanIdTlv>(aMessage, panId));
95
96 SuccessOrExit(MeshCoP::ChannelMaskTlv::FindIn(aMessage, mask));
97
98 mCallback.InvokeIfSet(panId, mask);
99
100 SuccessOrExit(Get<Tmf::Agent>().SendEmptyAck(aMessage, aMessageInfo));
101
102 LogInfo("Sent %s response", UriToString<kUriPanIdConflict>());
103
104 exit:
105 return;
106 }
107
108 } // namespace ot
109
110 #endif // OPENTHREAD_CONFIG_COMMISSIONER_ENABLE && OPENTHREAD_FTD
111