blob: 59180add71752c7ff43350447dfe466f9c3a2219 [file] [log] [blame]
/*
*
* 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.
*/
/**
* @file
* Provides the implementation of the OTA Image Processor class
* for Open IOT SDK platform.
*/
#pragma once
#include <app/clusters/ota-requestor/OTADownloader.h>
#include <lib/core/OTAImageHeader.h>
#include <platform/CHIPDeviceLayer.h>
#include <platform/OTAImageProcessor.h>
#include <psa/update.h>
namespace chip {
class OTAImageProcessorImpl : public OTAImageProcessorInterface
{
public:
//////////// OTAImageProcessorInterface Implementation ///////////////
CHIP_ERROR PrepareDownload() override;
CHIP_ERROR Finalize() override;
CHIP_ERROR Apply() override;
CHIP_ERROR Abort() override;
CHIP_ERROR ProcessBlock(ByteSpan & block) override;
bool IsFirstImageRun() override;
CHIP_ERROR ConfirmCurrentImage() override;
void SetOTADownloader(OTADownloader * downloader) { mDownloader = downloader; }
void SetImageId(psa_fwu_component_t id);
private:
//////////// Actual handlers for the OTAImageProcessorInterface ///////////////
static void HandlePrepareDownload(intptr_t context);
static void HandleFinalize(intptr_t context);
static void HandleApply(intptr_t context);
static void HandleAbort(intptr_t context);
static void HandleProcessBlock(intptr_t context);
/**
* Called to post OTA state change event
*/
void OnOTAStateChange(DeviceLayer::OtaState state);
/**
* Called to accumulate and decode header from data chunk
*/
CHIP_ERROR ProcessHeader(ByteSpan & block);
/**
* Called to allocate memory for mBlock if necessary and set it to block
*/
CHIP_ERROR SetBlock(ByteSpan & block);
/**
* Called to release allocated memory for mBlock
*/
CHIP_ERROR ReleaseBlock();
/**
* Called to clean up image preparation
*/
void UpdateShutdown();
MutableByteSpan mBlock;
OTADownloader * mDownloader;
OTAImageHeaderParser mHeaderParser;
psa_fwu_component_t mImageId;
};
inline void OTAImageProcessorImpl::SetImageId(psa_fwu_component_t id)
{
mImageId = id;
}
} // namespace chip