timebase_configs.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
   SPDX-FileCopyrightText: Copyright © 2025 Intel Corporation. */
 
#ifndef CLIENT_TIMEBASE_CONFIGS_H
#define CLIENT_TIMEBASE_CONFIGS_H
 
#include "pub/clkmgr/utility.h"
#include "pub/clkmgr/types.h"
#include <map>
#include <string>
 
__CLKMGR_NAMESPACE_BEGIN
 
class ClientConnectMessage;
class TimeBaseRecord;
class TimeBaseConfigurations;
struct TimeBaseCfg;
 
class PTPCfg
{
  private:
    std::string m_ifName; 
    uint8_t m_transportSpecific = 1; 
    uint8_t m_domainNumber = 0; 
    int m_ifIndex = -1; 
    int m_ptpIndex = -1; 
  protected:
    friend class TimeBaseConfigurations;
    friend class TimeBaseRecord;
    PTPCfg() = default;
    PTPCfg(const std::string &ifName, uint8_t transportSpecific,
        uint8_t domainNumber, int ifIndex = -1, int ptpIndex = -1);
  public:
    const std::string &ifName() const;
    const char *ifName_c() const;
    int ifIndex() const;
    int ptpIndex() const;
    uint8_t transportSpecific() const;
    uint8_t domainNumber() const;
};
 
class TimeBaseRecord
{
  private:
    size_t m_index = 0; 
    std::string m_name; 
    bool m_have_ptp = false; 
    PTPCfg m_ptp; 
    bool m_have_sys = false; 
  protected:
    #ifndef SWIG
    friend class TimeBaseConfigurations;
    TimeBaseRecord(size_t index, const std::string &name);
    void setPtp(PTPCfg &&ptp);
    #endif /* SWIG */
 
  public:
    TimeBaseRecord() = default;
    size_t index() const;
    const std::string &name() const;
    const char *name_c() const;
    bool havePtp() const;
    const PTPCfg &ptp() const;
    bool haveSysClock() const;
};
 
class TimeBaseConfigurations
{
  private:
    std::map<size_t, TimeBaseRecord> m_cfgs;
    TimeBaseConfigurations() = default;
    static TimeBaseConfigurations &getInstWr();
 
  protected:
    friend class ClientConnectMessage;
    static void addTimeBaseCfg(const struct TimeBaseCfg &cfg);
  public:
    #ifndef SWIG
    class iterator
    {
      private:
        std::map<size_t, TimeBaseRecord>::const_iterator it;
      protected:
        iterator(const std::map<size_t, TimeBaseRecord>::const_iterator &it);
        friend class TimeBaseConfigurations;
      public:
        /* iterator need to support these following operators */
        iterator &operator++(); /* prefix increment */
        iterator &operator++(int); /* postfix increment */
        const TimeBaseRecord &operator*();
        bool operator!=(iterator &o);
    };
    #endif /* SWIG */
    static const TimeBaseConfigurations &getInstance();
    static const TimeBaseRecord &getRecord(size_t timeBaseIndex);
    static bool isTimeBaseIndexPresent(size_t timeBaseIndex);
    static bool BaseNameToBaseIndex(const std::string &timeBaseName,
        size_t &timeBaseIndex);
    static size_t size();
    #ifndef SWIG
    static iterator begin();
    static iterator end();
    #endif /* SWIG */
};
 
__CLKMGR_NAMESPACE_END
 
#endif /* CLIENT_TIMEBASE_CONFIGS_H */