openthread/src/posix/platform/configuration.hpp

/*
 *  Copyright (c) 2022, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef OT_POSIX_PLATFORM_CONFIGURATION_HPP_
#define OT_POSIX_PLATFORM_CONFIGURATION_HPP_

#include "openthread-posix-config.h"

#if OPENTHREAD_POSIX_CONFIG_CONFIGURATION_FILE_ENABLE

#include <stdio.h>
#include <string.h>

#include <openthread/error.h>
#include <openthread/logging.h>
#include <openthread/platform/radio.h>

#include "config_file.hpp"
#include "logger.hpp"
#include "power.hpp"

#include "common/code_utils.hpp"

namespace ot {
namespace Posix {

/**
 * Updates the target power table and calibrated power table to the RCP.
 */
class Configuration : public Logger<Configuration>
{
public:
    static const char kLogModuleName[]; ///< Module name used for logging.

    Configuration(void)
        : mFactoryConfigFile(OPENTHREAD_POSIX_CONFIG_FACTORY_CONFIG_FILE)
        , mProductConfigFile(OPENTHREAD_POSIX_CONFIG_PRODUCT_CONFIG_FILE)
        , mRegionCode(0)
        , mSupportedChannelMask(kDefaultChannelMask)
        , mPreferredChannelMask(kDefaultChannelMask)
    {
    }

    /**
     * @brief Sets the path for the factory configuration file.
     *
     * @param[in] aFilePath  A null-terminated C string representing the new path to the
     *                       factory configuration file. This parameter MUST NOT be `nullptr`.
     *
     * @retval OT_ERROR_NONE           The factory configuration file path was successfully updated.
     * @retval OT_ERROR_INVALID_ARGS   If @p aFilePath is `nullptr`.
     */
    otError SetFactoryConfigFile(const char *aFilePath);

    /**
     * @brief Sets the path for the product configuration file.
     *
     * @param[in] aFilePath  A null-terminated C string representing the new path to the
     *                       product configuration file. This parameter MUST NOT be `nullptr`.
     *
     * @retval OT_ERROR_NONE           The product configuration file path was successfully updated.
     * @retval OT_ERROR_INVALID_ARGS   If @p aFilePath is `nullptr`.
     */
    otError SetProductConfigFile(const char *aFilePath);

    /**
     * Set the region code.
     *
     * The radio region format is the 2-bytes ascii representation of the
     * ISO 3166 alpha-2 code.
     *
     * @param[in]  aRegionCode  The radio region.
     *
     * @retval  OT_ERROR_NONE             Successfully set region code.
     * @retval  OT_ERROR_FAILED           Failed to set the region code.
     */
    otError SetRegion(uint16_t aRegionCode);

    /**
     * Get the region code.
     *
     * The radio region format is the 2-bytes ascii representation of the
     * ISO 3166 alpha-2 code.
     *
     * @returns  The region code.
     */
    uint16_t GetRegion(void) const { return mRegionCode; }

    /**
     * Get the radio supported channel mask that the device is allowed to be on.
     *
     * @returns The radio supported channel mask.
     */
    uint32_t GetSupportedChannelMask(void) const { return mSupportedChannelMask; }

    /**
     * Gets the radio preferred channel mask that the device prefers to form on.
     *
     * @returns The radio preferred channel mask.
     */
    uint32_t GetPreferredChannelMask(void) const { return mPreferredChannelMask; }

    /**
     * Indicates whether the configuration file are valid.
     *
     * @retval TRUE  If there are any valid configuration keys in the configuration file.
     * @retval FALSE If the configuration file doesn't exist or there is no key in the configuration file.
     */
    bool IsValid(void) const;

private:
#if OPENTHREAD_CONFIG_PLATFORM_POWER_CALIBRATION_ENABLE
    static const char kKeyCalibratedPower[];
#endif
    static const char         kKeyTargetPower[];
    static const char         kKeyRegionDomainMapping[];
    static const char         kKeySupportedChannelMask[];
    static const char         kKeyPreferredChannelMask[];
    static const char         kCommaDelimiter[];
    static constexpr uint16_t kMaxValueSize        = 512;
    static constexpr uint16_t kRegionCodeWorldWide = 0x5757;    // Region Code: "WW"
    static constexpr uint32_t kDefaultChannelMask  = 0x7fff800; // Channel 11 ~ 26

    uint16_t StringToRegionCode(const char *aString) const
    {
        return static_cast<uint16_t>(((aString[0] & 0xFF) << 8) | ((aString[1] & 0xFF) << 0));
    }
    otError GetDomain(uint16_t aRegionCode, Power::Domain &aDomain);
    otError GetChannelMask(const char *aKey, const Power::Domain &aDomain, uint32_t &aChannelMask);
    otError UpdateChannelMasks(const Power::Domain &aDomain);
#if OPENTHREAD_CONFIG_PLATFORM_POWER_CALIBRATION_ENABLE
    otError UpdateTargetPower(const Power::Domain &aDomain);
    otError UpdateCalibratedPower(void);
    otError GetNextTargetPower(const Power::Domain &aDomain, int &aIterator, Power::TargetPower &aTargetPower);
#endif

    ConfigFile mFactoryConfigFile;
    ConfigFile mProductConfigFile;
    uint16_t   mRegionCode;
    uint32_t   mSupportedChannelMask;
    uint32_t   mPreferredChannelMask;
};

} // namespace Posix
} // namespace ot

#endif // OPENTHREAD_POSIX_CONFIG_CONFIGURATION_FILE_ENABLE
#endif // OT_POSIX_PLATFORM_CONFIGURATION_HPP_