ptp.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later
   SPDX-FileCopyrightText: Copyright © 2023 Erez Geva <ErezGeva2@gmail.com> */
 
#ifndef __PTPMGMT_C_IF_H
#define __PTPMGMT_C_IF_H
 
#include "name.h"
#ifdef __PTPMGMT_HAVE_SYS_TYPES_H
#include <sys/types.h>
#else
typedef int clockid_t;
#endif /* __PTPMGMT_HAVE_SYS_TYPES_H */
#include <time.h>
#ifdef __linux__
#include <linux/ptp_clock.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ptpmgmt_ifInfo_t *ptpmgmt_ifInfo;
 
typedef const struct ptpmgmt_ifInfo_t *const_ptpmgmt_ifInfo;
 
struct ptpmgmt_ifInfo_t {
    void *_this; 
    void (*free)(ptpmgmt_ifInfo i);
    bool (*initUsingName)(ptpmgmt_ifInfo i, const char *ifName);
    bool (*initUsingIndex)(ptpmgmt_ifInfo i, int ifIndex);
    bool (*isInit)(const_ptpmgmt_ifInfo i);
    int (*ifIndex)(const_ptpmgmt_ifInfo i);
    const char *(*ifName)(const_ptpmgmt_ifInfo i);
    const uint8_t *(*mac)(const_ptpmgmt_ifInfo i);
    size_t (*mac_size)(const_ptpmgmt_ifInfo i);
    int (*ptpIndex)(const_ptpmgmt_ifInfo i);
};
 
ptpmgmt_ifInfo ptpmgmt_ifInfo_alloc();
 
typedef struct ptpmgmt_clock_t *ptpmgmt_clock;
 
typedef const struct ptpmgmt_clock_t *const_ptpmgmt_clock;
 
struct ptpmgmt_clock_t {
    void *_this; 
    void (*free)(ptpmgmt_clock clk);
 
    struct timespec(*getTime)(const_ptpmgmt_clock clk);
    bool (*setTime)(const_ptpmgmt_clock clk, const struct timespec *ts);
    bool (*offsetClock)(const_ptpmgmt_clock clk, int64_t offset);
    double (*getFreq)(const_ptpmgmt_clock clk);
    bool (*setFreq)(const_ptpmgmt_clock clk, double freq);
    bool (*setPhase)(const_ptpmgmt_clock clk, int64_t offset);
    bool (*isCharFile)(const char *file);
    bool (*initUsingDevice)(ptpmgmt_clock clk, const char *device, bool readonly);
    bool (*initUsingIndex)(ptpmgmt_clock clk, int ptpIndex, bool readonly);
    bool (*isInit)(const_ptpmgmt_clock clk);
    clockid_t (*clkId)(const_ptpmgmt_clock clk);
    int (*getFd)(const_ptpmgmt_clock clk);
    int (*fileno)(const_ptpmgmt_clock clk);
    int (*ptpIndex)(const_ptpmgmt_clock clk);
    const char *(*device)(const_ptpmgmt_clock clk);
    bool (*setTimeFromSys)(const_ptpmgmt_clock clk);
    bool (*setTimeToSys)(const_ptpmgmt_clock clk);
    bool (*fetchCaps)(const_ptpmgmt_clock clk, struct ptp_clock_caps *caps);
    bool (*readPin)(const_ptpmgmt_clock clk, unsigned int index,
        struct ptp_pin_desc *pin);
    bool (*writePin)(const_ptpmgmt_clock clk, struct ptp_pin_desc *pin);
    bool (*ExternTSEbable)(const_ptpmgmt_clock clk, unsigned int index,
        uint8_t flags);
    bool (*ExternTSDisable)(const_ptpmgmt_clock clk, unsigned int index);
    bool (*MaskClearAll)(const_ptpmgmt_clock clk);
    bool (*MaskEnable)(const_ptpmgmt_clock clk, unsigned int index);
    bool (*readEvent)(const_ptpmgmt_clock clk, struct ptp_extts_event *event);
    bool (*readEvents)(const_ptpmgmt_clock clk, struct ptp_extts_event *events,
        size_t *size);
    bool (*setPinPeriod)(const_ptpmgmt_clock clk, unsigned int index,
        struct ptp_perout_request *times);
    bool (*setPtpPpsEvent)(const_ptpmgmt_clock clk, bool enable);
    bool (*samplePtpSys)(const_ptpmgmt_clock clk, size_t count,
        struct ptp_sys_offset *samples);
    bool (*extSamplePtpSys)(const_ptpmgmt_clock clk, size_t count,
        struct ptp_sys_offset_extended *samples);
    bool (*preciseSamplePtpSys)(const_ptpmgmt_clock clk,
        struct ptp_sys_offset_precise *sample);
};
 
bool ptpmgmt_clock_isCharFile(const char *file);
 
ptpmgmt_clock ptpmgmt_clock_alloc();
 
ptpmgmt_clock ptpmgmt_clock_alloc_sys();
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PTPMGMT_C_IF_H */