phcclock.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_NETWORK
#include <cstdint>
#include <promeki/clockdomain.h>
#include <promeki/error.h>
#include <promeki/namespace.h>
#include <promeki/ntptime.h>
#include <promeki/result.h>
#include <promeki/string.h>
#include <promeki/timestamp.h>
#include <promeki/uniqueptr.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class PhcClock {
        public:
                PhcClock() = default;
 
                PhcClock(PhcClock &&other) noexcept;
                PhcClock &operator=(PhcClock &&other) noexcept;
 
                PhcClock(const PhcClock &) = delete;
                PhcClock &operator=(const PhcClock &) = delete;
 
                ~PhcClock();
 
                struct Caps {
                                int maxAdjustmentPpb = 0;       
                                int numAlarms = 0;              
                                int numExtTs = 0;               
                                int numPerOut = 0;              
                                int numPins = 0;                
                                bool ppsSupported = false;      
                                bool crossTimestamping = false; 
                                bool adjustPhase = false;       
                };
 
                struct SysOffset {
                                int64_t sysRealtimeNs = 0;     
                                int64_t phcNs = 0;             
                                int64_t sysRealtimePostNs = 0; 
                };
 
                static Result<PhcClock> open(const String &path = String("/dev/ptp0"));
 
                bool isOpen() const { return _fd >= 0; }
 
                const String &devicePath() const { return _path; }
 
                int fileDescriptor() const { return _fd; }
 
                const Caps &caps() const { return _caps; }
 
                Result<TimeStamp> now() const;
 
                Result<NtpTime> ntpNow() const;
 
                Result<SysOffset> sysOffsetPrecise() const;
 
                int taiUtcOffsetSeconds() const { return _taiUtcOffsetSec; }
 
                void setTaiUtcOffsetSeconds(int seconds) { _taiUtcOffsetSec = seconds; }
 
                Error refreshTaiUtcOffset();
 
                bool isLocked(int64_t toleranceNs = 1'000'000LL) const;
 
                void close();
 
                Error bindAsDomain(const ClockDomain::ID &domain = ClockDomain::Ptp);
 
                void unbindDomain(const ClockDomain::ID &domain = ClockDomain::Ptp);
 
                static int systemTaiUtcOffsetSeconds();
 
                static uint64_t utcNsToTaiNs(int64_t utcNs);
 
        private:
                explicit PhcClock(int fd, String path, Caps caps, int taiUtcSec)
                    : _fd(fd), _path(std::move(path)), _caps(caps),
                      _taiUtcOffsetSec(taiUtcSec) {}
 
                int    _fd = -1;
                String _path;
                Caps   _caps;
                int    _taiUtcOffsetSec = 37; 
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_NETWORK