bridge_storage_manager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#pragma once
 
#include "matter_bridged_device.h"
#include "persistent_storage/persistent_storage.h"
 
#ifdef CONFIG_BRIDGED_DEVICE_BT
#include <zephyr/bluetooth/addr.h>
#endif
 
namespace Nrf
{
 
/*
 * The class implements the following key-values storage structure:
 *
 * /br/
 *              /brd_cnt/ /<uint8_t>/
 *              /brd_ids/ /<uint8_t[brd_cnt]>/
 *              /brd/
 *                      /0/ /<BridgedDevice>/
 *                      /1/ /<BridgedDevice>/
 *                      .
 *                      .
 *                      /n/ /<BridgedDevice>/
 *              /ver/ <uint8_t>
 */
class BridgeStorageManager {
public:
        static inline constexpr auto kMaxUserDataSize = 128u;
 
        constexpr static auto kBridgePrefix = "br";
        constexpr static auto kBridgedDevicesCountPrefix = "brd_cnt";
        constexpr static auto kBridgedDevicesIndexesPrefix = "brd_ids";
        constexpr static auto kBridgedDevicePrefix = "brd";
        constexpr static auto kVersionPrefix = "ver";
 
#ifdef CONFIG_BRIDGE_MIGRATE_PRE_2_7_0
        constexpr static auto kBridgedDeviceEndpointIdPrefix = "eid";
        constexpr static auto kBridgedDeviceLabelPrefix = "label";
        constexpr static auto kBridgedDeviceTypePrefix = "type";
#ifdef CONFIG_BRIDGED_DEVICE_BT
        constexpr static auto kBtPrefix = "bt";
        constexpr static auto kBtAddrPrefix = "addr";
#endif
#endif
 
#ifdef CONFIG_BRIDGE_MIGRATE_VERSION_1
        struct BridgedDeviceV1 {
                uint16_t mEndpointId;
                uint16_t mDeviceType;
                size_t mNodeLabelLength;
                char mNodeLabel[MatterBridgedDevice::kNodeLabelSize] = { 0 };
                size_t mUserDataSize = 0;
                uint8_t *mUserData = nullptr;
        };
#endif
 
        struct BridgedDeviceV2 {
                uint16_t mEndpointId;
                uint16_t mDeviceType;
                size_t mUniqueIDLength;
                char mUniqueID[MatterBridgedDevice::kUniqueIDSize] = { 0 };
                size_t mNodeLabelLength;
                char mNodeLabel[MatterBridgedDevice::kNodeLabelSize] = { 0 };
                size_t mUserDataSize = 0;
                uint8_t *mUserData = nullptr;
        };
 
        using BridgedDevice = BridgedDeviceV2;
        static constexpr uint8_t kCurrentVersion = 2;
 
        static constexpr auto kMaxIndexLength = 3;
 
        BridgeStorageManager()
                : mBridge(kBridgePrefix, strlen(kBridgePrefix)),
                  mBridgedDevicesCount(kBridgedDevicesCountPrefix, strlen(kBridgedDevicesCountPrefix), &mBridge),
                  mBridgedDevicesIndexes(kBridgedDevicesIndexesPrefix, strlen(kBridgedDevicesIndexesPrefix), &mBridge),
                  mBridgedDevice(kBridgedDevicePrefix, strlen(kBridgedDevicePrefix), &mBridge),
                  mVersion(kVersionPrefix, strlen(kVersionPrefix), &mBridge)
#ifdef CONFIG_BRIDGE_MIGRATE_PRE_2_7_0
                  ,
                  mBridgedDeviceEndpointId(kBridgedDeviceEndpointIdPrefix, strlen(kBridgedDeviceEndpointIdPrefix),
                                           &mBridgedDevice),
                  mBridgedDeviceNodeLabel(kBridgedDeviceLabelPrefix, strlen(kBridgedDeviceLabelPrefix),
                                          &mBridgedDevice),
                  mBridgedDeviceType(kBridgedDeviceTypePrefix, strlen(kBridgedDeviceTypePrefix), &mBridgedDevice)
#ifdef CONFIG_BRIDGED_DEVICE_BT
                  ,
                  mBt(kBtPrefix, strlen(kBtPrefix), &mBridgedDevice),
                  mBtAddress(kBtAddrPrefix, strlen(kBtAddrPrefix), &mBt)
#endif
#endif
        {
        }
 
        static BridgeStorageManager &Instance()
        {
                static BridgeStorageManager sInstance;
                return sInstance;
        }
 
        bool Init();
 
        void FactoryReset();
 
        bool StoreBridgedDevicesCount(uint8_t count);
 
        bool LoadBridgedDevicesCount(uint8_t &count);
 
        bool StoreBridgedDevicesIndexes(uint8_t *indexes, uint8_t count);
 
        bool LoadBridgedDevicesIndexes(uint8_t *indexes, uint8_t maxCount, size_t &count);
 
        template <typename T = BridgedDevice> bool LoadBridgedDevice(T &device, uint8_t index);
 
        bool StoreBridgedDevice(BridgedDevice &device, uint8_t index);
 
        bool RemoveBridgedDevice(uint8_t bridgedDeviceIndex);
 
private:
        bool MigrateData();
 
#ifdef CONFIG_BRIDGE_MIGRATE_PRE_2_7_0
        bool MigrateDataOldScheme(uint8_t bridgedDeviceIndex);
#endif
 
#ifdef CONFIG_BRIDGE_MIGRATE_VERSION_1
        bool MigrateDataVersion1(uint8_t bridgedDeviceIndex);
#endif
 
        /* The below methods are deprecated and used only for the migration purposes between the older scheme versions.
         */
 
#ifdef CONFIG_BRIDGE_MIGRATE_PRE_2_7_0
        bool LoadBridgedDeviceEndpointId(uint16_t &endpointId, uint8_t bridgedDeviceIndex);
 
        bool RemoveBridgedDeviceEndpointId(uint8_t bridgedDeviceIndex);
 
        bool LoadBridgedDeviceNodeLabel(char *label, size_t labelMaxLength, size_t &labelLength,
                                        uint8_t bridgedDeviceIndex);
 
        bool RemoveBridgedDeviceNodeLabel(uint8_t bridgedDeviceIndex);
 
        bool LoadBridgedDeviceType(uint16_t &deviceType, uint8_t bridgedDeviceIndex);
 
        bool RemoveBridgedDeviceType(uint8_t bridgedDeviceIndex);
 
#ifdef CONFIG_BRIDGED_DEVICE_BT
        bool LoadBtAddress(bt_addr_le_t &addr, uint8_t bridgedDeviceIndex);
 
        bool RemoveBtAddress(uint8_t bridgedDeviceIndex);
#endif
#endif
 
        Nrf::PersistentStorageNode mBridge;
        Nrf::PersistentStorageNode mBridgedDevicesCount;
        Nrf::PersistentStorageNode mBridgedDevicesIndexes;
        Nrf::PersistentStorageNode mBridgedDevice;
        Nrf::PersistentStorageNode mVersion;
 
#ifdef CONFIG_BRIDGE_MIGRATE_PRE_2_7_0
        /* The below fields are deprecated and used only for the migration purposes between the older scheme versions.
         */
        Nrf::PersistentStorageNode mBridgedDeviceEndpointId;
        Nrf::PersistentStorageNode mBridgedDeviceNodeLabel;
        Nrf::PersistentStorageNode mBridgedDeviceType;
#ifdef CONFIG_BRIDGED_DEVICE_BT
        Nrf::PersistentStorageNode mBt;
        Nrf::PersistentStorageNode mBtAddress;
#endif
#endif
};
 
} /* namespace Nrf */