LXR linux/include/uapi/linux/ptp

   1/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
   2/*
   3 * PTP 1588 clock support - user space interface
   4 *
   5 * Copyright (C) 2010 OMICRON electronics GmbH
   6 *
   7 *  This program is free software; you can redistribute it and/or modify
   8 *  it under the terms of the GNU General Public License as published by
   9 *  the Free Software Foundation; either version 2 of the License, or
  10 *  (at your option) any later version.
  11 *
  12 *  This program is distributed in the hope that it will be useful,
  13 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 *  GNU General Public License for more details.
  16 *
  17 *  You should have received a copy of the GNU General Public License
  18 *  along with this program; if not, write to the Free Software
  19 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22#ifndef _PTP_CLOCK_H_
  23#define _PTP_CLOCK_H_
  24
  25#include <linux/ioctl.h>
  26#include <linux/types.h>
  27
  28/* PTP_xxx bits, for the flags field within the request structures. */
  29#define PTP_ENABLE_FEATURE (1<<0)
  30#define PTP_RISING_EDGE    (1<<1)
  31#define PTP_FALLING_EDGE   (1<<2)
  32
  33/*
  34 * struct ptp_clock_time - represents a time value
  35 *
  36 * The sign of the seconds field applies to the whole value. The
  37 * nanoseconds field is always unsigned. The reserved field is
  38 * included for sub-nanosecond resolution, should the demand for
  39 * this ever appear.
  40 *
  41 */
  42struct ptp_clock_time {
  43        __s64 sec;  /* seconds */
  44        __u32 nsec; /* nanoseconds */
  45        __u32 reserved;
  46};
  47
  48struct ptp_clock_caps {
  49        int max_adj;   /* Maximum frequency adjustment in parts per billon. */
  50        int n_alarm;   /* Number of programmable alarms. */
  51        int n_ext_ts;  /* Number of external time stamp channels. */
  52        int n_per_out; /* Number of programmable periodic signals. */
  53        int pps;       /* Whether the clock supports a PPS callback. */
  54        int n_pins;    /* Number of input/output pins. */
  55        /* Whether the clock supports precise system-device cross timestamps */
  56        int cross_timestamping;
  57        int rsv[13];   /* Reserved for future use. */
  58};
  59
  60struct ptp_extts_request {
  61        unsigned int index;  /* Which channel to configure. */
  62        unsigned int flags;  /* Bit field for PTP_xxx flags. */
  63        unsigned int rsv[2]; /* Reserved for future use. */
  64};
  65
  66struct ptp_perout_request {
  67        struct ptp_clock_time start;  /* Absolute start time. */
  68        struct ptp_clock_time period; /* Desired period, zero means disable. */
  69        unsigned int index;           /* Which channel to configure. */
  70        unsigned int flags;           /* Reserved for future use. */
  71        unsigned int rsv[4];          /* Reserved for future use. */
  72};
  73
  74#define PTP_MAX_SAMPLES 25 /* Maximum allowed offset measurement samples. */
  75
  76struct ptp_sys_offset {
  77        unsigned int n_samples; /* Desired number of measurements. */
  78        unsigned int rsv[3];    /* Reserved for future use. */
  79        /*
  80         * Array of interleaved system/phc time stamps. The kernel
  81         * will provide 2*n_samples + 1 time stamps, with the last
  82         * one as a system time stamp.
  83         */
  84        struct ptp_clock_time ts[2 * PTP_MAX_SAMPLES + 1];
  85};
  86
  87struct ptp_sys_offset_precise {
  88        struct ptp_clock_time device;
  89        struct ptp_clock_time sys_realtime;
  90        struct ptp_clock_time sys_monoraw;
  91        unsigned int rsv[4];    /* Reserved for future use. */
  92};
  93
  94enum ptp_pin_function {
  95        PTP_PF_NONE,
  96        PTP_PF_EXTTS,
  97        PTP_PF_PEROUT,
  98        PTP_PF_PHYSYNC,
  99};
 100
 101struct ptp_pin_desc {
 102        /*
 103         * Hardware specific human readable pin name. This field is
 104         * set by the kernel during the PTP_PIN_GETFUNC ioctl and is
 105         * ignored for the PTP_PIN_SETFUNC ioctl.
 106         */
 107        char name[64];
 108        /*
 109         * Pin index in the range of zero to ptp_clock_caps.n_pins - 1.
 110         */
 111        unsigned int index;
 112        /*
 113         * Which of the PTP_PF_xxx functions to use on this pin.
 114         */
 115        unsigned int func;
 116        /*
 117         * The specific channel to use for this function.
 118         * This corresponds to the 'index' field of the
 119         * PTP_EXTTS_REQUEST and PTP_PEROUT_REQUEST ioctls.
 120         */
 121        unsigned int chan;
 122        /*
 123         * Reserved for future use.
 124         */
 125        unsigned int rsv[5];
 126};
 127
 128#define PTP_CLK_MAGIC '='
 129
 130#define PTP_CLOCK_GETCAPS  _IOR(PTP_CLK_MAGIC, 1, struct ptp_clock_caps)
 131#define PTP_EXTTS_REQUEST  _IOW(PTP_CLK_MAGIC, 2, struct ptp_extts_request)
 132#define PTP_PEROUT_REQUEST _IOW(PTP_CLK_MAGIC, 3, struct ptp_perout_request)
 133#define PTP_ENABLE_PPS     _IOW(PTP_CLK_MAGIC, 4, int)
 134#define PTP_SYS_OFFSET     _IOW(PTP_CLK_MAGIC, 5, struct ptp_sys_offset)
 135#define PTP_PIN_GETFUNC    _IOWR(PTP_CLK_MAGIC, 6, struct ptp_pin_desc)
 136#define PTP_PIN_SETFUNC    _IOW(PTP_CLK_MAGIC, 7, struct ptp_pin_desc)
 137#define PTP_SYS_OFFSET_PRECISE \
 138        _IOWR(PTP_CLK_MAGIC, 8, struct ptp_sys_offset_precise)
 139
 140struct ptp_extts_event {
 141        struct ptp_clock_time t; /* Time event occured. */
 142        unsigned int index;      /* Which channel produced the event. */
 143        unsigned int flags;      /* Reserved for future use. */
 144        unsigned int rsv[2];     /* Reserved for future use. */
 145};
 146
 147#endif
 148