/* * * 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" #include "filogic.h" namespace chip { CHIP_ERROR OTAImageProcessorImpl::PrepareDownload() { ChipLogProgress(SoftwareUpdate, "OTAImageProcessorImpl::PrepareDownload()"); DeviceLayer::PlatformMgr().ScheduleWork(HandlePrepareDownload, reinterpret_cast(this)); return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::Finalize() { ChipLogProgress(SoftwareUpdate, "OTAImageProcessorImpl::Finalize()"); DeviceLayer::PlatformMgr().ScheduleWork(HandleFinalize, reinterpret_cast(this)); return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::Apply() { ChipLogProgress(SoftwareUpdate, "OTAImageProcessorImpl::Apply()"); filogic_ota_state_t err = FILOGIC_OTA_SUCCESS; filogic_ota_apply_sync(mFilogicCtx, &err); if (err != FILOGIC_OTA_SUCCESS) { ChipLogError(SoftwareUpdate, "OTA image apply fail"); return CHIP_ERROR_INTERNAL; } return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::Abort() { ChipLogError(SoftwareUpdate, "OTAImageProcessorImpl::Abort()"); DeviceLayer::PlatformMgr().ScheduleWork(HandleAbort, reinterpret_cast(this)); return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::ProcessBlock(ByteSpan & block) { CHIP_ERROR err = SetBlock(block); if (err != CHIP_NO_ERROR) { ChipLogError(SoftwareUpdate, "Cannot set block data: %" CHIP_ERROR_FORMAT, err.Format()); } ChipLogProgress(SoftwareUpdate, "OTAImageProcessorImpl::ProcessBlock()"); DeviceLayer::PlatformMgr().ScheduleWork(HandleProcessBlock, reinterpret_cast(this)); return CHIP_NO_ERROR; } void OTAImageProcessorImpl::HandlePrepareDownload(intptr_t context) { ChipLogProgress(SoftwareUpdate, "OTAImageProcessorImpl::HandlePrepareDownload()"); 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; } imageProcessor->mFilogicCtx = DeviceLayer::PlatformMgrImpl().mFilogicCtx; filogic_ota_state_t filogic_err; filogic_ota_init_sync(imageProcessor->mFilogicCtx, &filogic_err); if (filogic_err != FILOGIC_OTA_SUCCESS) { ChipLogError(SoftwareUpdate, "Filogic ota init fail"); return; } imageProcessor->mHeaderParser.Init(); if (!imageProcessor->mHeaderParser.IsInitialized()) { ChipLogError(SoftwareUpdate, "Header parser init fail!!"); } 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; } imageProcessor->ReleaseBlock(); } void OTAImageProcessorImpl::HandleAbort(intptr_t context) { auto * imageProcessor = reinterpret_cast(context); if (imageProcessor == nullptr) { return; } ChipLogProgress(SoftwareUpdate, "OTA image downloaded Abort handler"); imageProcessor->ReleaseBlock(); } void OTAImageProcessorImpl::HandleProcessBlock(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; } ByteSpan block = imageProcessor->mBlock; CHIP_ERROR err = imageProcessor->ProcessHeader(block); if (err != CHIP_NO_ERROR) { ChipLogError(SoftwareUpdate, "OTA process block header fail %" CHIP_ERROR_FORMAT, err.Format()); imageProcessor->mDownloader->EndDownload(CHIP_ERROR_INVALID_FILE_IDENTIFIER); return; } if (!block.empty()) { filogic_ota_state_t filogic_err; filogic_ota_io_write_sync(imageProcessor->mFilogicCtx, block.data(), block.size(), &filogic_err); if (filogic_err != FILOGIC_OTA_SUCCESS) { ChipLogError(SoftwareUpdate, "OTA process block fail %d", filogic_err); imageProcessor->mDownloader->EndDownload(CHIP_ERROR_WRITE_FAILED); return; } } ChipLogProgress(SoftwareUpdate, "OTA downloaded bytes: %ld", static_cast(imageProcessor->mParams.downloadedBytes)); imageProcessor->mParams.downloadedBytes += block.size(); imageProcessor->mDownloader->FetchNextData(); } // // Store block data for HandleProcessBlock to access CHIP_ERROR OTAImageProcessorImpl::SetBlock(ByteSpan & block) { if (block.empty()) { ReleaseBlock(); return CHIP_NO_ERROR; } if (mBlock.size() < block.size()) { ReleaseBlock(); mBlock = MutableByteSpan(static_cast(chip::Platform::MemoryAlloc(block.size())), block.size()); if (mBlock.data() == nullptr) { return CHIP_ERROR_NO_MEMORY; } } 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; } 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 currentVersion; ReturnErrorOnFailure(DeviceLayer::ConfigurationMgr().GetSoftwareVersion(currentVersion)); if (currentVersion != requestor->GetTargetVersion()) { return CHIP_ERROR_INCORRECT_STATE; } return CHIP_NO_ERROR; } CHIP_ERROR OTAImageProcessorImpl::ProcessHeader(ByteSpan & block) { ChipLogProgress(SoftwareUpdate, "ProcessHeader enter!!"); 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); ChipLogProgress(SoftwareUpdate, "Image Header software version: %ld payload size: %lu", header.mSoftwareVersion, (long unsigned int) header.mPayloadSize); mParams.totalFileBytes = header.mPayloadSize; mHeaderParser.Clear(); } return CHIP_NO_ERROR; } } // namespace chip