firmware_update.hpp

// SPDX-License-Identifier: Apache-2.0
// Copyright Pionix GmbH and Contributors to EVerest
 
#pragma once
 
#include <ocpp/v2/message_handler.hpp>
 
namespace ocpp::v2 {
// Formward declarations.
struct FunctionalBlockContext;
class AvailabilityInterface;
class SecurityInterface;
 
struct UpdateFirmwareRequest;
struct UpdateFirmwareResponse;
 
// Typedef
typedef std::function<UpdateFirmwareResponse(const UpdateFirmwareRequest& request)> UpdateFirmwareRequestCallback;
typedef std::function<void()> AllConnectorsUnavailableCallback;
 
class FirmwareUpdateInterface : public MessageHandlerInterface {
public:
    virtual ~FirmwareUpdateInterface() = default;
 
    virtual void on_firmware_update_status_notification(int32_t request_id,
                                                        const FirmwareStatusEnum& firmware_update_status) = 0;
    virtual void on_firmware_status_notification_request() = 0;
};
 
class FirmwareUpdate : public FirmwareUpdateInterface {
private: // Members
    const FunctionalBlockContext& context;
    AvailabilityInterface& availability;
    SecurityInterface& security;
 
    UpdateFirmwareRequestCallback update_firmware_request_callback;
    std::optional<AllConnectorsUnavailableCallback> all_connectors_unavailable_callback;
 
    FirmwareStatusEnum firmware_status;
    // The request ID in the last firmware update status received
    std::optional<int32_t> firmware_status_id;
    // The last firmware status which will be posted before the firmware is installed.
    FirmwareStatusEnum firmware_status_before_installing = FirmwareStatusEnum::SignatureVerified;
 
public:
    FirmwareUpdate(const FunctionalBlockContext& functional_block_context, AvailabilityInterface& availability,
                   SecurityInterface& security, UpdateFirmwareRequestCallback update_firmware_request_callback,
                   std::optional<AllConnectorsUnavailableCallback> all_connectors_unavailable_callback);
    void handle_message(const ocpp::EnhancedMessage<MessageType>& message) override;
    void on_firmware_update_status_notification(int32_t request_id,
                                                const FirmwareStatusEnum& firmware_update_status) override;
    void on_firmware_status_notification_request() override;
 
private: // Functions
    // Functional Block L: Firmware management
    void handle_firmware_update_req(Call<UpdateFirmwareRequest> call);
 
    void change_all_connectors_to_unavailable_for_firmware_update();
 
    void restore_all_connector_states();
};
} // namespace ocpp::v2