cfgbus_pps.h

Go to the documentation of this file.

// Copyright 2024-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/cfgbus_core.h>
#include <satcat5/polling.h>
#include <satcat5/ptp_source.h>
#include <satcat5/ptp_time.h>
 
namespace satcat5 {
    namespace cfg {
        class PpsEventListener {
        public:
            virtual void pps_event(
                satcat5::ptp::Time& timestamp,  // PPS event timestamp.
                satcat5::ptp::Time& delta)      // Unfiltered phase correction.
                = 0;                            // Child MUST override this.
        protected:
            ~PpsEventListener() {}
        };
 
        class PpsInput : protected satcat5::poll::Timer {
        public:
            enum class Edge {FALLING=0, RISING=1, BOTH=2};
 
            explicit PpsInput(satcat5::cfg::Register reg,
                satcat5::cfg::PpsInput::Edge mode = Edge::RISING);
 
            inline void set_callback(satcat5::cfg::PpsEventListener* cb)
                { m_callback = cb; }
 
            inline satcat5::ptp::Time last_pps() const { return m_pps_time; }
 
            inline Edge get_mode() const        { return m_mode; }
 
            inline s64 get_offset() const       { return m_offset; }
 
            inline void set_offset(s64 offset)  { m_offset = offset; }
 
            void reset(Edge mode = Edge::RISING);
 
        protected:
            // Internal methods.
            bool read_pulse();              // Attempt to read one pulse
            void timer_event() override;    // Timer event handler
 
            // Internal state.
            satcat5::cfg::Register m_reg;
            satcat5::cfg::PpsEventListener* m_callback;
            satcat5::ptp::Time m_pps_time;
            Edge m_mode;
            s64 m_offset;
            s64 m_period;
        };
 
        class PpsOutput : protected satcat5::poll::Timer {
        public:
            explicit PpsOutput(satcat5::cfg::Register reg, bool rising=true);
 
            inline s64 get_offset() const
                { return m_offset; }
 
            void set_offset(s64 offset);
 
            inline bool get_polarity() const
                { return m_rising; }
 
            void set_polarity(bool rising);
 
        protected:
            // Internal methods.
            void configure();               // Reload all parameters
            void timer_event() override;    // Timer event handler
 
            // Internal state.
            satcat5::cfg::Register m_reg;
            s64 m_offset;
            bool m_rising;
        };
 
        class RefOutput : public satcat5::cfg::PpsOutput {
        public:
            explicit RefOutput(
                satcat5::cfg::Register reg_phase,
                satcat5::cfg::Register reg_period,
                bool rising=true);
 
            inline u32 get_frequency() const
                { return m_freq_hz; }
 
            void set_frequency(u32 freq_hz);
 
        protected:
            // Internal state.
            satcat5::cfg::Register m_reg_period;
            u32 m_freq_hz;
        };
    }
}