blob: f3a73f6dbae9688b52242c856bf5db0a95a7b75e [file] [log] [blame]
/*
*
* Copyright (c) 2020 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
* Utilities for accessing persisted device configuration on
* platforms based on the Qorvo QPG6100 SDK.
*/
#ifndef QPG6100_CONFIG_H
#define QPG6100_CONFIG_H
#include <platform/internal/CHIPDeviceLayerInternal.h>
#include "FreeRTOS.h"
#include <functional>
namespace chip {
namespace DeviceLayer {
namespace Internal {
/* Base for the category calculation when determining the key IDs */
#define CATEGORY_BASE 0x01
constexpr inline uint16_t QorvoConfigKey(uint8_t categoryId, uint8_t id)
{
return static_cast<uint16_t>(((categoryId) << 6) | (id & 0x3F));
}
/**
* This implementation uses the Qorvo NVM component as the underlying storage layer.
*
* NOTE: This class is designed to be mixed-in to the concrete subclass of the
* GenericConfigurationManagerImpl<> template. When used this way, the class
* naturally provides implementations for the delegated members referenced by
* the template class (e.g. the ReadConfigValue() method).
*/
class QPG6100Config
{
public:
// Category ids used by the CHIP Device Layer
static constexpr uint8_t kFileId_ChipFactory = CATEGORY_BASE; /**< Category containing persistent config values set at
* manufacturing time. Retained during factory reset. */
static constexpr uint8_t kFileId_ChipConfig = CATEGORY_BASE + 1; /**< Catyegory containing dynamic config values set at runtime.
* Cleared during factory reset. */
static constexpr uint8_t kFileId_ChipCounter = CATEGORY_BASE + 2; /**< Category containing dynamic counter values set at
* runtime. Retained during factory reset. */
using Key = uint16_t;
// Key definitions for well-known configuration values.
static constexpr Key kConfigKey_SerialNum = QorvoConfigKey(kFileId_ChipFactory, 0x00);
static constexpr Key kConfigKey_MfrDeviceId = QorvoConfigKey(kFileId_ChipFactory, 0x01);
static constexpr Key kConfigKey_MfrDeviceCert = QorvoConfigKey(kFileId_ChipFactory, 0x02);
static constexpr Key kConfigKey_MfrDevicePrivateKey = QorvoConfigKey(kFileId_ChipFactory, 0x03);
static constexpr Key kConfigKey_ManufacturingDate = QorvoConfigKey(kFileId_ChipFactory, 0x04);
static constexpr Key kConfigKey_SetupPinCode = QorvoConfigKey(kFileId_ChipFactory, 0x05);
static constexpr Key kConfigKey_MfrDeviceICACerts = QorvoConfigKey(kFileId_ChipFactory, 0x06);
static constexpr Key kConfigKey_SetupDiscriminator = QorvoConfigKey(kFileId_ChipFactory, 0x07);
static constexpr Key kConfigKey_FabricId = QorvoConfigKey(kFileId_ChipConfig, 0x00);
static constexpr Key kConfigKey_ServiceConfig = QorvoConfigKey(kFileId_ChipConfig, 0x01);
static constexpr Key kConfigKey_PairedAccountId = QorvoConfigKey(kFileId_ChipConfig, 0x02);
static constexpr Key kConfigKey_ServiceId = QorvoConfigKey(kFileId_ChipConfig, 0x03);
static constexpr Key kConfigKey_FabricSecret = QorvoConfigKey(kFileId_ChipConfig, 0x04);
static constexpr Key kConfigKey_LastUsedEpochKeyId = QorvoConfigKey(kFileId_ChipConfig, 0x05);
static constexpr Key kConfigKey_FailSafeArmed = QorvoConfigKey(kFileId_ChipConfig, 0x06);
static constexpr Key kConfigKey_GroupKey = QorvoConfigKey(kFileId_ChipConfig, 0x07);
static constexpr Key kConfigKey_ProductRevision = QorvoConfigKey(kFileId_ChipConfig, 0x08);
static constexpr Key kConfigKey_OperationalDeviceId = QorvoConfigKey(kFileId_ChipConfig, 0x09);
static constexpr Key kConfigKey_OperationalDeviceCert = QorvoConfigKey(kFileId_ChipConfig, 0x0A);
static constexpr Key kConfigKey_OperationalDeviceICACerts = QorvoConfigKey(kFileId_ChipConfig, 0x0B);
static constexpr Key kConfigKey_OperationalDevicePrivateKey = QorvoConfigKey(kFileId_ChipConfig, 0x0C);
static constexpr Key kConfigKey_GroupKeyBase = QorvoConfigKey(kFileId_ChipConfig, 0x0D);
static constexpr Key kConfigKey_GroupKeyMax = QorvoConfigKey(kFileId_ChipConfig, 0x1C); // Allows 16 Group Keys to be created.
static constexpr Key kConfigKey_CounterKeyBase = QorvoConfigKey(kFileId_ChipCounter, 0x00);
static constexpr Key kConfigKey_CounterKeyMax =
QorvoConfigKey(kFileId_ChipCounter, 0x1F); // Allows 32 Counter Keys to be created.
// Set key id limits for each group.
static constexpr Key kMinConfigKey_ChipFactory = kConfigKey_SerialNum;
static constexpr Key kMaxConfigKey_ChipFactory = kConfigKey_SetupDiscriminator;
static constexpr Key kMinConfigKey_ChipConfig = kConfigKey_FabricId;
static constexpr Key kMaxConfigKey_ChipConfig = kConfigKey_GroupKeyMax;
static constexpr Key kMinConfigKey_ChipCounter = kConfigKey_CounterKeyBase;
static constexpr Key kMaxConfigKey_ChipCounter = kConfigKey_CounterKeyMax; // Allows 32 Counters to be created.
static CHIP_ERROR Init(void);
// Configuration methods used by the GenericConfigurationManagerImpl<> template.
static uint16_t GetSettingsMaxValueLength(uint16_t Key);
static CHIP_ERROR ReadConfigValue(Key key, bool & val);
static CHIP_ERROR ReadConfigValue(Key key, uint32_t & val);
static CHIP_ERROR ReadConfigValue(Key key, uint64_t & val);
static CHIP_ERROR ReadConfigValueStr(Key key, char * buf, size_t bufSize, size_t & outLen);
static CHIP_ERROR ReadConfigValueBin(Key key, uint8_t * buf, size_t bufSize, size_t & outLen);
static CHIP_ERROR WriteConfigValue(Key key, bool val);
static CHIP_ERROR WriteConfigValue(Key key, uint32_t val);
static CHIP_ERROR WriteConfigValue(Key key, uint64_t val);
static CHIP_ERROR WriteConfigValueStr(Key key, const char * str);
static CHIP_ERROR WriteConfigValueStr(Key key, const char * str, size_t strLen);
static CHIP_ERROR WriteConfigValueBin(Key key, const uint8_t * data, size_t dataLen);
static CHIP_ERROR ClearConfigValue(Key key);
static bool ConfigValueExists(Key key);
static CHIP_ERROR FactoryResetConfig(void);
static void RunConfigUnitTest(void);
protected:
using ForEachRecordFunct = std::function<CHIP_ERROR(const Key & key, const size_t & length)>;
static CHIP_ERROR ForEachRecord(uint16_t fileId, uint16_t recordKey, bool addNewRecord, ForEachRecordFunct funct);
private:
};
} // namespace Internal
} // namespace DeviceLayer
} // namespace chip
#endif // QPG6100_CONFIG_H