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 /* 29 * Bits of the ptp_extts_request.flags field: 30 */ 31 #define PTP_ENABLE_FEATURE (1<<0) 32 #define PTP_RISING_EDGE (1<<1) 33 #define PTP_FALLING_EDGE (1<<2) 34 #define PTP_EXTTS_EDGES (PTP_RISING_EDGE | PTP_FALLING_EDGE) 35 36 /* 37 * flag fields valid for the new PTP_EXTTS_REQUEST2 ioctl. 38 */ 39 #define PTP_EXTTS_VALID_FLAGS (PTP_ENABLE_FEATURE | \ 40 PTP_RISING_EDGE | \ 41 PTP_FALLING_EDGE) 42 43 /* 44 * flag fields valid for the original PTP_EXTTS_REQUEST ioctl. 45 * DO NOT ADD NEW FLAGS HERE. 46 */ 47 #define PTP_EXTTS_V1_VALID_FLAGS (PTP_ENABLE_FEATURE | \ 48 PTP_RISING_EDGE | \ 49 PTP_FALLING_EDGE) 50 51 /* 52 * Bits of the ptp_perout_request.flags field: 53 */ 54 #define PTP_PEROUT_ONE_SHOT (1<<0) 55 56 /* 57 * flag fields valid for the new PTP_PEROUT_REQUEST2 ioctl. 58 */ 59 #define PTP_PEROUT_VALID_FLAGS (PTP_PEROUT_ONE_SHOT) 60 61 /* 62 * No flags are valid for the original PTP_PEROUT_REQUEST ioctl 63 */ 64 #define PTP_PEROUT_V1_VALID_FLAGS (0) 65 66 /* 67 * struct ptp_clock_time - represents a time value 68 * 69 * The sign of the seconds field applies to the whole value. The 70 * nanoseconds field is always unsigned. The reserved field is 71 * included for sub-nanosecond resolution, should the demand for 72 * this ever appear. 73 * 74 */ 75 struct ptp_clock_time { 76 __s64 sec; /* seconds */ 77 __u32 nsec; /* nanoseconds */ 78 __u32 reserved; 79 }; 80 81 struct ptp_clock_caps { 82 int max_adj; /* Maximum frequency adjustment in parts per billon. */ 83 int n_alarm; /* Number of programmable alarms. */ 84 int n_ext_ts; /* Number of external time stamp channels. */ 85 int n_per_out; /* Number of programmable periodic signals. */ 86 int pps; /* Whether the clock supports a PPS callback. */ 87 int n_pins; /* Number of input/output pins. */ 88 /* Whether the clock supports precise system-device cross timestamps */ 89 int cross_timestamping; 90 int rsv[13]; /* Reserved for future use. */ 91 }; 92 93 struct ptp_extts_request { 94 unsigned int index; /* Which channel to configure. */ 95 unsigned int flags; /* Bit field for PTP_xxx flags. */ 96 unsigned int rsv[2]; /* Reserved for future use. */ 97 }; 98 99 struct ptp_perout_request { 100 struct ptp_clock_time start; /* Absolute start time. */ 101 struct ptp_clock_time period; /* Desired period, zero means disable. */ 102 unsigned int index; /* Which channel to configure. */ 103 unsigned int flags; 104 unsigned int rsv[4]; /* Reserved for future use. */ 105 }; 106 107 #define PTP_MAX_SAMPLES 25 /* Maximum allowed offset measurement samples. */ 108 109 struct ptp_sys_offset { 110 unsigned int n_samples; /* Desired number of measurements. */ 111 unsigned int rsv[3]; /* Reserved for future use. */ 112 /* 113 * Array of interleaved system/phc time stamps. The kernel 114 * will provide 2*n_samples + 1 time stamps, with the last 115 * one as a system time stamp. 116 */ 117 struct ptp_clock_time ts[2 * PTP_MAX_SAMPLES + 1]; 118 }; 119 120 struct ptp_sys_offset_extended { 121 unsigned int n_samples; /* Desired number of measurements. */ 122 unsigned int rsv[3]; /* Reserved for future use. */ 123 /* 124 * Array of [system, phc, system] time stamps. The kernel will provide 125 * 3*n_samples time stamps. 126 */ 127 struct ptp_clock_time ts[PTP_MAX_SAMPLES][3]; 128 }; 129 130 struct ptp_sys_offset_precise { 131 struct ptp_clock_time device; 132 struct ptp_clock_time sys_realtime; 133 struct ptp_clock_time sys_monoraw; 134 unsigned int rsv[4]; /* Reserved for future use. */ 135 }; 136 137 enum ptp_pin_function { 138 PTP_PF_NONE, 139 PTP_PF_EXTTS, 140 PTP_PF_PEROUT, 141 PTP_PF_PHYSYNC, 142 }; 143 144 struct ptp_pin_desc { 145 /* 146 * Hardware specific human readable pin name. This field is 147 * set by the kernel during the PTP_PIN_GETFUNC ioctl and is 148 * ignored for the PTP_PIN_SETFUNC ioctl. 149 */ 150 char name[64]; 151 /* 152 * Pin index in the range of zero to ptp_clock_caps.n_pins - 1. 153 */ 154 unsigned int index; 155 /* 156 * Which of the PTP_PF_xxx functions to use on this pin. 157 */ 158 unsigned int func; 159 /* 160 * The specific channel to use for this function. 161 * This corresponds to the 'index' field of the 162 * PTP_EXTTS_REQUEST and PTP_PEROUT_REQUEST ioctls. 163 */ 164 unsigned int chan; 165 /* 166 * Reserved for future use. 167 */ 168 unsigned int rsv[5]; 169 }; 170 171 #define PTP_CLK_MAGIC '=' 172 173 #define PTP_CLOCK_GETCAPS _IOR(PTP_CLK_MAGIC, 1, struct ptp_clock_caps) 174 #define PTP_EXTTS_REQUEST _IOW(PTP_CLK_MAGIC, 2, struct ptp_extts_request) 175 #define PTP_PEROUT_REQUEST _IOW(PTP_CLK_MAGIC, 3, struct ptp_perout_request) 176 #define PTP_ENABLE_PPS _IOW(PTP_CLK_MAGIC, 4, int) 177 #define PTP_SYS_OFFSET _IOW(PTP_CLK_MAGIC, 5, struct ptp_sys_offset) 178 #define PTP_PIN_GETFUNC _IOWR(PTP_CLK_MAGIC, 6, struct ptp_pin_desc) 179 #define PTP_PIN_SETFUNC _IOW(PTP_CLK_MAGIC, 7, struct ptp_pin_desc) 180 #define PTP_SYS_OFFSET_PRECISE \ 181 _IOWR(PTP_CLK_MAGIC, 8, struct ptp_sys_offset_precise) 182 #define PTP_SYS_OFFSET_EXTENDED \ 183 _IOWR(PTP_CLK_MAGIC, 9, struct ptp_sys_offset_extended) 184 185 #define PTP_CLOCK_GETCAPS2 _IOR(PTP_CLK_MAGIC, 10, struct ptp_clock_caps) 186 #define PTP_EXTTS_REQUEST2 _IOW(PTP_CLK_MAGIC, 11, struct ptp_extts_request) 187 #define PTP_PEROUT_REQUEST2 _IOW(PTP_CLK_MAGIC, 12, struct ptp_perout_request) 188 #define PTP_ENABLE_PPS2 _IOW(PTP_CLK_MAGIC, 13, int) 189 #define PTP_SYS_OFFSET2 _IOW(PTP_CLK_MAGIC, 14, struct ptp_sys_offset) 190 #define PTP_PIN_GETFUNC2 _IOWR(PTP_CLK_MAGIC, 15, struct ptp_pin_desc) 191 #define PTP_PIN_SETFUNC2 _IOW(PTP_CLK_MAGIC, 16, struct ptp_pin_desc) 192 #define PTP_SYS_OFFSET_PRECISE2 \ 193 _IOWR(PTP_CLK_MAGIC, 17, struct ptp_sys_offset_precise) 194 #define PTP_SYS_OFFSET_EXTENDED2 \ 195 _IOWR(PTP_CLK_MAGIC, 18, struct ptp_sys_offset_extended) 196 197 struct ptp_extts_event { 198 struct ptp_clock_time t; /* Time event occured. */ 199 unsigned int index; /* Which channel produced the event. */ 200 unsigned int flags; /* Reserved for future use. */ 201 unsigned int rsv[2]; /* Reserved for future use. */ 202 }; 203 204 #endif 205