/* * * Copyright (c) 2021 Project CHIP Authors * All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include #include #include "OTAImageProcessorImpl.h" namespace chip { bool OTAImageProcessorImpl::IsFirstImageRun() { OTARequestorInterface * requestor = chip::GetRequestorInstance(); if (requestor == nullptr) { return false; } return requestor->GetCurrentUpdateState() == OTARequestorInterface::OTAUpdateStateEnum::kApplying; } CHIP_ERROR OTAImageProcessorImpl::ConfirmCurrentImage() { OTARequestorInterface * requestor = chip::GetRequestorInstance(); if (requestor == nullptr) { return CHIP_ERROR_INTERNAL; } uint32_t currentSwVersion; uint32_t targetVersion = requestor->GetTargetVersion(); ReturnErrorOnFailure(DeviceLayer::ConfigurationMgr().GetSoftwareVersion(currentSwVersion)); if (currentSwVersion != targetVersion) { ChipLogError(SoftwareUpdate, "Current software version = %" PRIu32 ", expected software version = %" PRIu32, currentSwVersion, targetVersion); return CHIP_ERROR_INCORRECT_STATE; } return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::PrepareDownload() { // Get OTA status - under what circumstances does prepared break? // what happens if a prepare is pending and another one is invoked // Should we store the state here and wait until we receive notification mHeaderParser.Init(); DeviceLayer::PlatformMgr().ScheduleWork(HandlePrepareDownload, reinterpret_cast(this)); return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::ProcessHeader(ByteSpan & block) { if (mHeaderParser.IsInitialized()) { OTAImageHeader header; CHIP_ERROR error = mHeaderParser.AccumulateAndDecode(block, header); // Needs more data to decode the header VerifyOrReturnError(error != CHIP_ERROR_BUFFER_TOO_SMALL, CHIP_NO_ERROR); ReturnErrorOnFailure(error); mParams.totalFileBytes = header.mPayloadSize; mHeaderParser.Clear(); // Load qvCHIP_Ota header structure and call application callback to validate image header qvCHIP_Ota_ImageHeader_t qvCHIP_OtaImgHeader; this->mSwVer = header.mSoftwareVersion; // Store software version in imageProcessor as well qvCHIP_OtaImgHeader.vendorId = header.mVendorId; qvCHIP_OtaImgHeader.productId = header.mProductId; qvCHIP_OtaImgHeader.softwareVersion = header.mSoftwareVersion; qvCHIP_OtaImgHeader.minApplicableVersion = header.mMinApplicableVersion.ValueOr(0); qvCHIP_OtaImgHeader.maxApplicableVersion = header.mMaxApplicableVersion.ValueOr(0); if (true != qvCHIP_OtaValidateImage(qvCHIP_OtaImgHeader)) { // Dropping image due to invalid header return CHIP_DEVICE_ERROR_SOFTWARE_UPDATE_IGNORED; } } return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::Finalize() { DeviceLayer::PlatformMgr().ScheduleWork(HandleFinalize, reinterpret_cast(this)); return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::Apply() { ChipLogProgress(SoftwareUpdate, "Q: Applying - resetting device"); // Reset into Bootloader qvCHIP_OtaReset(); return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::Abort() { DeviceLayer::PlatformMgr().ScheduleWork(HandleAbort, reinterpret_cast(this)); return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::ProcessBlock(ByteSpan & block) { if ((block.data() == nullptr) || block.empty()) { return CHIP_ERROR_INVALID_ARGUMENT; } CHIP_ERROR err = ProcessHeader(block); if (err != CHIP_NO_ERROR) { ChipLogError(SoftwareUpdate, "Matter image header parser error %s", chip::ErrorStr(err)); this->mDownloader->EndDownload(CHIP_ERROR_INVALID_FILE_IDENTIFIER); return err; } // Store block data for HandleProcessBlock to access err = SetBlock(block); if (err != CHIP_NO_ERROR) { ChipLogError(SoftwareUpdate, "Cannot set block data: %" CHIP_ERROR_FORMAT, err.Format()); return err; } DeviceLayer::PlatformMgr().ScheduleWork(HandleProcessBlock, reinterpret_cast(this)); return CHIP_NO_ERROR; } void OTAImageProcessorImpl::HandlePrepareDownload(intptr_t context) { auto * imageProcessor = reinterpret_cast(context); if (imageProcessor == nullptr) { ChipLogError(SoftwareUpdate, "ImageProcessor context is null"); return; } else if (imageProcessor->mDownloader == nullptr) { ChipLogError(SoftwareUpdate, "mDownloader is null"); return; } // running this in a thread so won't block main event loop ChipLogProgress(SoftwareUpdate, "Q: HandlePrepareDownload"); qvCHIP_OtaEraseArea(); qvCHIP_OtaStartWrite(); // Initialize tracking variables imageProcessor->mParams.downloadedBytes = 0; imageProcessor->mDownloader->OnPreparedForDownload(CHIP_NO_ERROR); } void OTAImageProcessorImpl::HandleFinalize(intptr_t context) { auto * imageProcessor = reinterpret_cast(context); if (imageProcessor == nullptr) { return; } ChipLogProgress(SoftwareUpdate, "Q: HandleFinalize"); qvCHIP_OtaSetPendingImage(); imageProcessor->ReleaseBlock(); // Start from scratch imageProcessor->mParams.downloadedBytes = 0; } void OTAImageProcessorImpl::HandleAbort(intptr_t context) { auto * imageProcessor = reinterpret_cast(context); if (imageProcessor == nullptr) { return; } ChipLogProgress(SoftwareUpdate, "Q: HandleAbort"); imageProcessor->ReleaseBlock(); // Start from scratch imageProcessor->mParams.downloadedBytes = 0; } void OTAImageProcessorImpl::HandleProcessBlock(intptr_t context) { qvCHIP_OtaStatus_t status; auto * imageProcessor = reinterpret_cast(context); if (imageProcessor == nullptr) { ChipLogError(SoftwareUpdate, "ImageProcessor context is null"); return; } else if (imageProcessor->mDownloader == nullptr) { ChipLogError(SoftwareUpdate, "mDownloader is null"); return; } ChipLogDetail(SoftwareUpdate, "Q: HandleProcessBlock"); status = qvCHIP_OtaWriteChunk(imageProcessor->mParams.downloadedBytes, static_cast(imageProcessor->mBlock.size()), reinterpret_cast(imageProcessor->mBlock.data())); if (status != qvCHIP_OtaStatusSuccess) { ChipLogError(SoftwareUpdate, "Flash write failed"); imageProcessor->mDownloader->EndDownload(CHIP_ERROR_WRITE_FAILED); return; } imageProcessor->mParams.downloadedBytes += imageProcessor->mBlock.size(); imageProcessor->mDownloader->FetchNextData(); } CHIP_ERROR OTAImageProcessorImpl::SetBlock(ByteSpan & block) { if (block.empty()) { ReleaseBlock(); return CHIP_NO_ERROR; } if (mBlock.size() < block.size()) { if (!mBlock.empty()) { ReleaseBlock(); } uint8_t * mBlock_ptr = static_cast(chip::Platform::MemoryAlloc(block.size())); if (mBlock_ptr == nullptr) { return CHIP_ERROR_NO_MEMORY; } mBlock = MutableByteSpan(mBlock_ptr, block.size()); } CHIP_ERROR err = CopySpanToMutableSpan(block, mBlock); if (err != CHIP_NO_ERROR) { ChipLogError(SoftwareUpdate, "Cannot copy block data: %" CHIP_ERROR_FORMAT, err.Format()); return err; } return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::ReleaseBlock() { if (mBlock.data() != nullptr) { chip::Platform::MemoryFree(mBlock.data()); } mBlock = MutableByteSpan(); return CHIP_NO_ERROR; } } // namespace chip