blob: a7cd7028608421a5173580714f876199179f54ba [file] [log] [blame]
* Copyright (c) 2020-2022 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
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
* @file
* Utilities for accessing persisted device configuration on
* webOS platforms.
#pragma once
#include <functional>
#include <inttypes.h>
#include <lib/core/CHIPError.h>
namespace chip {
namespace DeviceLayer {
namespace Internal {
class ChipLinuxStorage;
* Provides functions and definitions for accessing device configuration information on the Posix.
* This class is designed to be mixed-in to concrete implementation classes as a means to
* provide access to configuration information to generic base classes.
class PosixConfig
struct Key;
// Maximum length of an NVS key name.
static constexpr size_t kMaxConfigKeyNameLength = 15;
// NVS namespaces used to store device configuration information.
static const char kConfigNamespace_ChipFactory[];
static const char kConfigNamespace_ChipConfig[];
static const char kConfigNamespace_ChipCounters[];
// Key definitions for well-known keys.
static const Key kConfigKey_SerialNum;
static const Key kConfigKey_UniqueId;
static const Key kConfigKey_MfrDeviceId;
static const Key kConfigKey_MfrDeviceCert;
static const Key kConfigKey_MfrDeviceICACerts;
static const Key kConfigKey_MfrDevicePrivateKey;
static const Key kConfigKey_HardwareVersion;
static const Key kConfigKey_ManufacturingDate;
static const Key kConfigKey_SetupPinCode;
static const Key kConfigKey_FabricId;
static const Key kConfigKey_ServiceConfig;
static const Key kConfigKey_PairedAccountId;
static const Key kConfigKey_ServiceId;
static const Key kConfigKey_FabricSecret;
static const Key kConfigKey_GroupKeyIndex;
static const Key kConfigKey_LastUsedEpochKeyId;
static const Key kConfigKey_FailSafeArmed;
static const Key kConfigKey_WiFiStationSecType;
static const Key kConfigKey_SetupDiscriminator;
static const Key kConfigKey_RegulatoryLocation;
static const Key kConfigKey_CountryCode;
static const Key kConfigKey_Breadcrumb;
static const Key kConfigKey_LocationCapability;
static const Key kConfigKey_Spake2pIterationCount;
static const Key kConfigKey_Spake2pSalt;
static const Key kConfigKey_Spake2pVerifier;
static const Key kConfigKey_VendorId;
static const Key kConfigKey_ProductId;
static const Key kCounterKey_RebootCount;
static const Key kCounterKey_UpTime;
static const Key kCounterKey_TotalOperationalHours;
static const Key kCounterKey_BootReason;
static const char kGroupKeyNamePrefix[];
static CHIP_ERROR Init();
// Config value accessors.
static CHIP_ERROR ReadConfigValue(Key key, bool & val);
static CHIP_ERROR ReadConfigValue(Key key, uint16_t & 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, uint16_t 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();
static CHIP_ERROR FactoryResetCounters();
static void RunConfigUnitTest();
// NVS Namespace helper functions.
static CHIP_ERROR EnsureNamespace(const char * ns);
static CHIP_ERROR ClearNamespace(const char * ns);
static ChipLinuxStorage * GetStorageForNamespace(Key key);
struct PosixConfig::Key
const char * Namespace;
const char * Name;
bool operator==(const Key & other) const;
inline bool PosixConfig::Key::operator==(const Key & other) const
return strcmp(Namespace, other.Namespace) == 0 && strcmp(Name, other.Name) == 0;
} // namespace Internal
} // namespace DeviceLayer
} // namespace chip