IEEE1588Timer.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef IEEE1588TIMER_H
#define IEEE1588TIMER_H
 
#include <nbrtos.h>
#include <ethervars.h>
#include <cstdint>
#include <sys/types.h>
 
const uint32_t target_sec_count  =1000000000u;
const uint32_t max_valid_interval=1000200000u;
const uint32_t min_valid_interval= 999899999u;
 
// Offset between Unix epoch (1970) and NTP epoch (1900) in seconds
const uint32_t UNIX_NTP_OFFSET = 2208988800u;
 
 
class IEEE1588Timer
{
   private:
    // Ring buffer for PPS captures (256 entries, using uint8_t indices for automatic wraparound)
    volatile uint32_t PPSCaptures[256];   
    volatile uint32_t PPSTimeTick[256];   
    volatile uint32_t PPSNTPTime[256];    
    volatile uint32_t PPSNTPSetCap[256];
    volatile uint32_t PPSNTPSetTT[256];
    volatile uint32_t PPSLoop;            
 
    // Static instance pointer for ISR access
    static IEEE1588Timer *instance;
 
   public:
       // GPS synchronization tracking
       volatile uint32_t  ConsecutiveSecs;   
       volatile uint32_t LastValidTime;     
 
    IEEE1588Timer();
 
    bool init();
 
    uint32_t getCurrentTime(EthernetVars &ev);
 
    void enablePPSCapture();
 
    void markValidTime(uint32_t tt, uint32_t cap_1588, uint32_t ntpTime);
 
    uint32_t getConsecutiveValidSeconds() const { return ConsecutiveSecs; }
 
    void updateConsecutiveSeconds(uint32_t currentTimeTick);
 
    void resetConsecutiveSeconds() { ConsecutiveSecs = 0; }
 
    uint32_t getPPSLoop() const { return PPSLoop; }
 
    uint32_t getPPSCapture(uint32_t index) const { return PPSCaptures[index&0xFF]; }
    uint32_t getPPSTimeTick(uint32_t index) const { return PPSTimeTick[index&0xFF]; }
    uint32_t getPPSNTPTime(uint32_t index) const { return PPSNTPTime[index&0xFF]; }
    uint32_t getPPSNTPSetCap(uint32_t index) const { return PPSNTPSetCap[index&0xFF]; } 
    uint32_t getPPSNTPSetTT(uint32_t index) const { return PPSNTPSetTT[index&0xFF]; } 
    bool hasValidGPSTime() const;
 
    time_t getGPSUnixTime() const;
 
    bool getGPSTimeWithMillis(EthernetVars &ev, time_t &unixSecs, uint32_t &millis);
 
    static void PPS_1588_TimeCapIsr();
 
    static inline uint32_t ring_diff_forward(uint32_t a, uint32_t b)
    {
        return a - b;   // (a after b) mod 2^32
    }
 
    static inline uint32_t ring_diff_min(uint32_t a, uint32_t b)
    {
        uint32_t d1 = a - b;   // forward
        uint32_t d2 = b - a;   // backward
        return (d1 < d2) ? d1 : d2;
    }
};
 
// Global instance declaration - defined in IEEE1588Timer.cpp
extern IEEE1588Timer ieee1588Timer;
 
#endif   // IEEE1588TIMER_H