examples/platform/nrfconnect/util/include/DFUOverSMP.h

/*
 *
 *    Copyright (c) 2021 Project CHIP Authors
 *
 *    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 an implementation of Device Firmware Upgrade using SMP protocol
 *      over Bluetooth LE functionality for nRF Connect SDK platform.
 */

#pragma once

#include <platform/Zephyr/BLEAdvertisingArbiter.h>

#include <array>

/**
 * @brief DFU over SMP helper class
 *
 * The purpose of this class is to enable Device Firmware Upgrade mechanism
 * using Simple Management Protocol (SMP) over Bluetooth LE. Besides
 * facilitating initialization of the SMP server, it is capable of requesting
 * BLE advertising in a way that is compatible with other application components
 * that use BLE, such as Matter BLE layer.
 */
class DFUOverSMP
{
public:
    /**
     * @brief Initialize DFU over SMP utility
     *
     * Initialize internal structures and register necessary commands in the SMP
     * server.
     */
    void Init();

    /**
     * @brief Confirm the current firmware image
     *
     * In case the current image is run tentatively after performing the
     * firmware update, approve it to prevent the system from restoring the
     * previous image on the next boot.
     */
    void ConfirmNewImage();

    /**
     * @brief Start BLE SMP server
     *
     * Register SMP BLE service that supports image management commands and
     * request BLE advertising. The BLE advertising may begin immediately, or be
     * deferred if another component with higher priority uses BLE.
     */
    void StartServer();

private:
    bool mIsStarted                                                       = false;
    chip::DeviceLayer::BLEAdvertisingArbiter::Request mAdvertisingRequest = {};
    std::array<bt_data, 2> mAdvertisingItems;

    friend DFUOverSMP & GetDFUOverSMP();
    static DFUOverSMP sDFUOverSMP;
};

inline DFUOverSMP & GetDFUOverSMP()
{
    return DFUOverSMP::sDFUOverSMP;
}