|
| 1 | +/* |
| 2 | + * |
| 3 | + * Copyright (c) 2021 Project CHIP Authors |
| 4 | + * |
| 5 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + * you may not use this file except in compliance with the License. |
| 7 | + * You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | + |
| 18 | +#include <BdxOtaSender.h> |
| 19 | + |
| 20 | +#include <lib/core/CHIPError.h> |
| 21 | +#include <lib/support/BitFlags.h> |
| 22 | +#include <lib/support/CHIPMemString.h> |
| 23 | +#include <messaging/ExchangeContext.h> |
| 24 | +#include <messaging/Flags.h> |
| 25 | +#include <protocols/bdx/BdxTransferSession.h> |
| 26 | + |
| 27 | +using chip::bdx::StatusCode; |
| 28 | +using chip::bdx::TransferControlFlags; |
| 29 | +using chip::bdx::TransferSession; |
| 30 | + |
| 31 | +void BdxOtaSender::SetCallbacks(BdxOtaSenderCallbacks callbacks) |
| 32 | +{ |
| 33 | + mOnBlockQueryCallback = callbacks.onBlockQuery; |
| 34 | + mOnTransferCompleteCallback = callbacks.onTransferComplete; |
| 35 | + mOnTransferFailedCallback = callbacks.onTransferFailed; |
| 36 | +} |
| 37 | + |
| 38 | +void BdxOtaSender::HandleTransferSessionOutput(TransferSession::OutputEvent & event) |
| 39 | +{ |
| 40 | + CHIP_ERROR err = CHIP_NO_ERROR; |
| 41 | + |
| 42 | + if (event.EventType != TransferSession::OutputEventType::kNone) |
| 43 | + { |
| 44 | + ChipLogDetail(BDX, "OutputEvent type: %s", event.ToString(event.EventType)); |
| 45 | + } |
| 46 | + |
| 47 | + switch (event.EventType) |
| 48 | + { |
| 49 | + case TransferSession::OutputEventType::kNone: |
| 50 | + break; |
| 51 | + case TransferSession::OutputEventType::kMsgToSend: { |
| 52 | + chip::Messaging::SendFlags sendFlags; |
| 53 | + if (!event.msgTypeData.HasMessageType(chip::Protocols::SecureChannel::MsgType::StatusReport)) |
| 54 | + { |
| 55 | + // All messages sent from the Sender expect a response, except for a StatusReport which would indicate an error and the |
| 56 | + // end of the transfer. |
| 57 | + sendFlags.Set(chip::Messaging::SendMessageFlags::kExpectResponse); |
| 58 | + } |
| 59 | + VerifyOrReturn(mExchangeCtx != nullptr, ChipLogError(BDX, "%s: mExchangeCtx is null", __FUNCTION__)); |
| 60 | + err = mExchangeCtx->SendMessage(event.msgTypeData.ProtocolId, event.msgTypeData.MessageType, std::move(event.MsgData), |
| 61 | + sendFlags); |
| 62 | + if (err != CHIP_NO_ERROR) |
| 63 | + { |
| 64 | + ChipLogError(BDX, "SendMessage failed: %s", chip::ErrorStr(err)); |
| 65 | + } |
| 66 | + break; |
| 67 | + } |
| 68 | + case TransferSession::OutputEventType::kInitReceived: { |
| 69 | + // TransferSession will automatically reject a transfer if there are no |
| 70 | + // common supported control modes. It will also default to the smaller |
| 71 | + // block size. |
| 72 | + TransferSession::TransferAcceptData acceptData; |
| 73 | + acceptData.ControlMode = TransferControlFlags::kReceiverDrive; // OTA must use receiver drive |
| 74 | + acceptData.MaxBlockSize = mTransfer.GetTransferBlockSize(); |
| 75 | + acceptData.StartOffset = mTransfer.GetStartOffset(); |
| 76 | + acceptData.Length = mTransfer.GetTransferLength(); |
| 77 | + VerifyOrReturn(mTransfer.AcceptTransfer(acceptData) == CHIP_NO_ERROR, |
| 78 | + ChipLogError(BDX, "%s: %s", __FUNCTION__, chip::ErrorStr(err))); |
| 79 | + break; |
| 80 | + } |
| 81 | + case TransferSession::OutputEventType::kQueryReceived: { |
| 82 | + TransferSession::BlockData blockData; |
| 83 | + uint16_t blockSize = mTransfer.GetTransferBlockSize(); |
| 84 | + uint16_t bytesToRead = blockSize; |
| 85 | + |
| 86 | + chip::System::PacketBufferHandle blockBuf = chip::System::PacketBufferHandle::New(bytesToRead); |
| 87 | + if (blockBuf.IsNull()) |
| 88 | + { |
| 89 | + // TODO: AbortTransfer() needs to support GeneralStatusCode failures as well as BDX specific errors. |
| 90 | + mTransfer.AbortTransfer(StatusCode::kUnknown); |
| 91 | + return; |
| 92 | + } |
| 93 | + |
| 94 | + if (mOnBlockQueryCallback != nullptr && mOnBlockQueryCallback->mCall != nullptr) |
| 95 | + { |
| 96 | + if (CHIP_NO_ERROR != |
| 97 | + mOnBlockQueryCallback->mCall(mOnBlockQueryCallback->mContext, blockBuf, blockData.Length, blockData.IsEof, |
| 98 | + mNumBytesSent)) |
| 99 | + { |
| 100 | + ChipLogError(BDX, "onBlockQuery Callback failed"); |
| 101 | + mTransfer.AbortTransfer(StatusCode::kUnknown); |
| 102 | + return; |
| 103 | + } |
| 104 | + } |
| 105 | + else |
| 106 | + { |
| 107 | + ChipLogError(BDX, "onBlockQuery Callback not set"); |
| 108 | + mTransfer.AbortTransfer(StatusCode::kUnknown); |
| 109 | + return; |
| 110 | + } |
| 111 | + |
| 112 | + blockData.Data = blockBuf->Start(); |
| 113 | + mNumBytesSent = static_cast<uint32_t>(mNumBytesSent + blockData.Length); |
| 114 | + |
| 115 | + VerifyOrReturn(CHIP_NO_ERROR == mTransfer.PrepareBlock(blockData), |
| 116 | + ChipLogError(BDX, "%s: PrepareBlock failed: %s", __FUNCTION__, chip::ErrorStr(err))); |
| 117 | + break; |
| 118 | + } |
| 119 | + case TransferSession::OutputEventType::kAckReceived: |
| 120 | + break; |
| 121 | + case TransferSession::OutputEventType::kAckEOFReceived: |
| 122 | + ChipLogDetail(BDX, "Transfer completed, got AckEOF"); |
| 123 | + if (mOnTransferCompleteCallback != nullptr && mOnTransferCompleteCallback->mCall != nullptr) |
| 124 | + { |
| 125 | + mOnTransferCompleteCallback->mCall(mOnTransferCompleteCallback->mContext); |
| 126 | + } |
| 127 | + else |
| 128 | + { |
| 129 | + ChipLogError(BDX, "onTransferComplete Callback not set"); |
| 130 | + } |
| 131 | + Reset(); |
| 132 | + break; |
| 133 | + case TransferSession::OutputEventType::kStatusReceived: |
| 134 | + ChipLogError(BDX, "Got StatusReport %x", static_cast<uint16_t>(event.statusData.statusCode)); |
| 135 | + if (mOnTransferFailedCallback != nullptr && mOnTransferFailedCallback->mCall != nullptr) |
| 136 | + { |
| 137 | + mOnTransferFailedCallback->mCall(mOnTransferFailedCallback->mContext, kErrorBdxSenderStatusReceived); |
| 138 | + } |
| 139 | + else |
| 140 | + { |
| 141 | + ChipLogError(BDX, "onTransferFailed Callback not set"); |
| 142 | + } |
| 143 | + Reset(); |
| 144 | + break; |
| 145 | + case TransferSession::OutputEventType::kInternalError: |
| 146 | + ChipLogError(BDX, "InternalError"); |
| 147 | + if (mOnTransferFailedCallback != nullptr && mOnTransferFailedCallback->mCall != nullptr) |
| 148 | + { |
| 149 | + mOnTransferFailedCallback->mCall(mOnTransferFailedCallback->mContext, kErrorBdxSenderInternal); |
| 150 | + } |
| 151 | + { |
| 152 | + ChipLogError(BDX, "onTransferFailed Callback not set"); |
| 153 | + } |
| 154 | + Reset(); |
| 155 | + break; |
| 156 | + case TransferSession::OutputEventType::kTransferTimeout: |
| 157 | + ChipLogError(BDX, "Transfer timed out"); |
| 158 | + if (mOnTransferFailedCallback != nullptr && mOnTransferFailedCallback->mCall != nullptr) |
| 159 | + { |
| 160 | + mOnTransferFailedCallback->mCall(mOnTransferFailedCallback->mContext, kErrorBdxSenderTimeOut); |
| 161 | + } |
| 162 | + { |
| 163 | + ChipLogError(BDX, "onTransferFailed Callback not set"); |
| 164 | + } |
| 165 | + Reset(); |
| 166 | + break; |
| 167 | + case TransferSession::OutputEventType::kAcceptReceived: |
| 168 | + case TransferSession::OutputEventType::kBlockReceived: |
| 169 | + default: |
| 170 | + // TransferSession should prevent this case from happening. |
| 171 | + ChipLogError(BDX, "%s: unsupported event type", __FUNCTION__); |
| 172 | + } |
| 173 | +} |
| 174 | + |
| 175 | +void BdxOtaSender::Reset() |
| 176 | +{ |
| 177 | + mTransfer.Reset(); |
| 178 | + if (mExchangeCtx != nullptr) |
| 179 | + { |
| 180 | + mExchangeCtx->Close(); |
| 181 | + } |
| 182 | + mNumBytesSent = 0; |
| 183 | +} |
| 184 | + |
| 185 | +uint16_t BdxOtaSender::GetTransferBlockSize(void) |
| 186 | +{ |
| 187 | + return mTransfer.GetTransferBlockSize(); |
| 188 | +} |
| 189 | + |
| 190 | +uint64_t BdxOtaSender::GetTransferLength() |
| 191 | +{ |
| 192 | + return mTransfer.GetTransferLength(); |
| 193 | +} |
0 commit comments