text: /*
   *
   *    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 persistent device configuration on
   *          Zephyr platforms.
   */
  
  #pragma once
  
  #include <platform/internal/CHIPDeviceLayerInternal.h>
  
  namespace chip {
  namespace DeviceLayer {
  namespace Internal {
  
  /**
   * Provides functions and definitions for accessing device configuration information on Zephyr platforms.
   *
   * This implementation uses Zephyr Settings API as the underlying storage layer.
   *
   * 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 ZephyrConfig
  {
  public:
      using Key = const char[];
  
      // Key definitions for well-known keys.
      static const Key kConfigKey_SerialNum;
      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_SetupDiscriminator;
      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_RegulatoryLocation;
      static const Key kConfigKey_CountryCode;
      static const Key kConfigKey_ActiveLocale;
      static const Key kConfigKey_Breadcrumb;
  
      static const Key kCounterKey_RebootCount;
      static const Key kCounterKey_BootReason;
      static const Key kCounterKey_TotalOperationalHours;
  
      static CHIP_ERROR Init(void);
  
      // Config value accessors.
      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 ReadConfigValueCounter(::chip::Platform::PersistedStorage::Key counterId, uint32_t & val);
      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 WriteConfigValueCounter(::chip::Platform::PersistedStorage::Key counterId, uint32_t val);
      static CHIP_ERROR ClearConfigValue(Key key);
      static bool ConfigValueExists(Key key);
      static CHIP_ERROR FactoryResetConfig(void);
  
      static void RunConfigUnitTest(void);
  
  private:
      static bool BuildCounterConfigKey(::chip::Platform::PersistedStorage::Key counterId, char key[]);
  };
  } // namespace Internal
  } // namespace DeviceLayer
  } // namespace chip
  